Often, we notice our customers trying to decide on how to choose the right mix of content for their Knowledge Base — help docs or videos or do we add guides Here is an easy-to-grasp and straightforward approach. You can start by considering your product’s 1. Complexity 2. Technicality 🧩Product complexity: This defines the learning curve required to use your product efficiently 🧑💻Product technicality: This defines the level of coding knowledge required to use the product. For example: for a low complexity and low technicality product: Use guides and bite-sized videos to convey the basic features of your product We researched and wrote an actionable guide on setting up your Knowledge Base that explains this framework (with examples). Link in comments.
Trainn’s Post
More Relevant Posts
-
I'm excited to share our latest blog post titled "Teaching Old Assert() New Tricks." This article delves into innovative approaches to enhance the functionality of the assert() method, making it a more powerful tool in your development toolkit. Whether you're looking to refine your testing process or elevate your code quality, this post offers valuable insights and practical tips. Discover how to breathe new life into a familiar function and improve your coding practices. Read the full article here: https://ift.tt/CfljKnx.
To view or add a comment, sign in
-
Ever wondered how to make your code shine through awesome documentation? Look no further! 🌐✨ We've compiled 5 tips to help you write effective developer documentation and elevate your code to new heights 🚀 1️⃣ Know Your Audience: Make sure your docs speak to everyone using your code. 2️⃣ Keep It Simple: Organize your info so it's easy for everyone to understand. 3️⃣ Show, Don't Tell: Use examples to guide folks through your code. 4️⃣ Stay Updated: Keep your docs fresh and in sync with any changes. 5️⃣ Engage Users: Use cool tools to make your documentation interactive. Got any tips to add or a favorite from the list? Share them with us! 👇👇 #DeveloperTips #CodeDocumentation #TechTalk #CodingTips #CodeDocs
To view or add a comment, sign in
-
Ever faced the challenge of navigating a codebase that's resistant to change and plagued with bugs? Despite best intentions, teams often find themselves battling code that's hard to test and resistant to change. Dive into the evidence-backed insights from Michele Tufano's academic paper, "When and Why Your Code Starts To Smell Bad" (2015). Key Learnings: 1️⃣ Code smells often originate early in the process 2️⃣ Early identification of smelly classes is possible 3️⃣ Experienced developers are prone to introducing code smells 4️⃣ Code smells peak just before a release 5️⃣ Busy developers are major contributors to code smells Practical Tips for Coaches: ✅ Familiarize your team with code smells ✅ Utilize Lines of Code to spot lengthy classes early on ✅ Incorporate code smell checks in code reviews and pair programming ✅ Foster a flexible initial design for resilient code Explore the findings in more detail: https://lnkd.in/dh37HpeP Your insights matter! Share your thoughts and let's refine our approach together. 🚀
To view or add a comment, sign in
-
Code Snippet Savvy: Unleash Efficiency in Your Development Workflow (Part 1)! Ever wished you had pre-written, reusable code chunks to streamline your development process? Code snippets are your secret weapon! This blog series dives deep into their power. Part 1 explores: What are Code Snippets & Why Use Them? Discover the magic of code snippets and how they can boost your development efficiency. Creating Reusable Code Blocks: Learn best practices for crafting effective and maintainable code snippets. Organization & Management: Explore strategies for organizing and managing your code snippet library for easy access. Ready to become a code snippet superhero? Head over to Part 1 and unlock a new level of development efficiency! ➡️ https://lnkd.in/gJbd2-ZA P.S. Share your biggest challenges with code reusability in the comments! Let's exchange tips and tricks to become a collective of coding wizards. #CodeSnippets #SoftwareDevelopment #DeveloperProductivity #CodeReuse #Efficiency #BlogSeries #ProgrammingTips
To view or add a comment, sign in
-
I am excited to share my latest blog post on the importance of self-documenting code. In this post, I explore how writing code that is inherently understandable can significantly enhance collaboration and streamline maintenance. The discussion includes practical tips on how to achieve clarity in your code, ultimately reducing the need for excessive comments. Discover how adopting these practices can lead to more efficient development processes and better overall code quality. Read the full article here: [Self-Documenting Code](https://ift.tt/VfWUOy7)
To view or add a comment, sign in
-
Ever start a "quick project" that somehow turns into a digital Hydra? My recent adventure with a side project: Day 1: MVP done. It asks users for missing logs. Day 5: Feature complete. Time to celebrate! Day 6: "Hey, I could make it do this too..." Day 7: There's this feature that might be cool! Day 8: This is getting a bit long, maybe I should refactor. Day 9: You know what would be cool? Getting the Adeptus Mechanicus to write my readme! Lots of extra new features, refactoring, and some regret later... Day 30: This feature looks sorta shiny, let's try it! Day today: Uh oh I forgot to update the unit tests... What I've learned: 1. "Just one more feature" is a dangerous phrase. 2. Your side project can and will develop its own agenda. 3. Scope creep is real, and it's coming for your free time. Anyone else been down this rabbit hole? Share your scope creep stories! Github link to the project: https://lnkd.in/gJwHckzV Lessons learned: lots of stuff is possible if you apply enough coffee to the problem.
To view or add a comment, sign in
-
Software Engineer 1 @ Cimpress India | Ex-Intern Connectwise, Cimpress | JavaScript, Node.js, React JS,AWS, Serverless
🚀 𝗔𝗻𝗻𝗼𝘂𝗻𝗰𝗶𝗻𝗴 𝘁𝗵𝗲 𝗧𝗲𝘀𝘁𝗧𝗲𝗺𝗽𝗹𝗮𝘁𝗲 𝗩𝗦 𝗖𝗼𝗱𝗲 𝗘𝘅𝘁𝗲𝗻𝘀𝗶𝗼𝗻! 🎉 I'm excited to introduce my latest project: TestTemplate, a VS Code extension designed to streamline your test development process. This extension provides handy snippets for various hooks and test structures, ensuring you can focus more on writing tests rather than setting them up. 🌟 𝗙𝗲𝗮𝘁𝘂𝗿𝗲𝘀 TestTemplate offers several snippets to make your test writing more efficient: 𝗰𝗿𝗲𝗮𝘁𝗲𝗧𝗲𝘀𝘁: Generates a complete test template 🧩 𝗶𝘁: Creates an it block for individual test cases 🔍 𝗯𝗲: Generates a beforeEach block for setup code ⚙️ 𝗮𝗲: Generates an afterEach block for teardown code 🧹 𝗯𝗮: Creates a beforeAll block for code that runs before all tests 🛠️ 𝗮𝗳: Creates an afterAll block for code that runs after all tests 🗑️ 🛠️ 𝗛𝗼𝘄 𝘁𝗼 𝗨𝘀𝗲 After installing the extension, you can use the snippets by typing the respective shortcut in your test file. Feel free to leave feedback. Your suggestions are highly appreciated and will help improve the extension. ✨
To view or add a comment, sign in
-
Frustrated by code reviews that feel like they're just ticking boxes? Overly complex reviews slow down development, consuming valuable time without improving code quality. What if these reviews could be transformed into events that not only catch errors, but also improve the maintainability of your code? Here’s a better way to conduct code reviews: 🛠️ Differential Reading: Compare old and new code to clearly see changes. 🤔 Asking 'Why': Understand the purpose behind each change, fostering more in-depth insights. 🔄 Rotational Pair Reviews: Rotate review partners to gain diverse perspectives and insights. This shift makes your code cleaner and enhances your efficiency and reduces maintenance headaches. Dive into this week’s newsletter for easy-to-implement strategies that improve your code review. Interested in refining your review techniques? Check out the first comment below for the link!
To view or add a comment, sign in
-
Software Engineer @ Sierra Interactive + Founding Engineer @ AuditionCat | TypeScript | React | Node | RESTful API
Working through my presentation prep for The Software Engineer's Guidebook, I was reminded of the many great ways to "unblock" yourself: 🦆 1. Rubber duck - Discuss your problem with a "rubber duck" or other friendly object...or yourself if you must. Verbalizing your problem may prompt new ideas! ✏ 2. Draw it out - Sketch the problem. Visualizing it might trigger new approaches! 🤓 3. Read the docs - Reference the tech on which you're blocked. Are you using it right? Is there an option you're not seeing? Look for clues! 🤖 4. Use AI - Input your problem with options you've already tried and see what the tool suggests. 🔎 5. Search online - Try multiple phrases and terms to see if others have already found a solution to a problem like yours that you can leverage. ❓ 6. Try forums - Use internal or external Q&A options to see if others have ideas or have bridged a similar gap. Explaining it to others may also prompt those new ideas! ☕ 7. Take a break - Step away, grab coffee, nap, try another task, or whatever works. When you come back you may find a new perspective! ⌨ 8. Start over or backtrack - This has helped me a lot. Maybe you went too far and lost focus. Rewinding gives you a clean slate to solve the problem with the added benefit of more knowledge of the work already. It will likely be faster! 🙋♀️ LAST RESORT - Seek help after you've given solo options a solid try. Asking for help is a GOOD thing, but you should come prepared with things you've done or researched so you don't waste others' time! 🤔 Anything you want to add? #softwareengineering #softwaredevelopment #programmoing #coding #solveproblems #askforhelp #thesoftwareengineersguidebook #tools #unblockyourself
To view or add a comment, sign in
-
Welcome to our upcoming webinar with Oscar Olsson 🗣 Code Smells: Enhance your Code-Nose and Impress Your Peers Have you ever looked at a piece of code and felt that something was off, even if you couldn't quite put your finger on it? Welcome to the world of Code Smells - a fascinating realm where seemingly innocent code hides deeper design issues waiting to be uncovered. A Code Smell is a concept in programming that refers to a pattern in the code which, while not necessarily incorrect, can indicate a deeper design issue that may cause problems down the line. In this presentation, you will be exposed to several examples of code with various flaws and learn how to address them. Not least, you will get the names of the most important Code Smells. After the presentation, you will: - Gain the skills to quickly spot and resolve code quality problems, making your projects run smoother. - Know the specific names and types of Code Smells, enabling you to discuss and address code issues more effectively with your colleagues. - Improve the code quality and maintainability of your code. This webinar is ideal for developers, team leads, and code reviewers looking to improve code quality and communication 📆 17th October 12.00-12.30 Sign up here: https://lnkd.in/dh_fty6x #developersbay #webinar #codesmells #code #tech #it
To view or add a comment, sign in
2,204 followers
Link to the guide - https://trainn.co/understanding-knowledge-base-software/