In our recent episode on the Knowledgebase Ninjas podcast, Brianne Bennett, Lead Technical Writer at Opensee delves into the difference between using Docs-as-code vs a Dedicated knowledge base tool for creating documentation. She also speaks about the factors that should be considered when switching to a knowledge base tool.
About Brianne
- Brianne’s LinkedIn
- After completing her Masters in technical writing, she began her career as a technical writer.
- Her current role primarily focuses on translation, which differs significantly from her first job and gives her a different perspective of the technical writing role.
Key Takeaways
- According to Brianne, the main difference between docs as code and a dedicated knowledge base is the focus. In docs as code the emphasis is given to the code and the product, while a dedicated knowledge base prioritizes the users and the community.
- Brianne believes the quality of documentation tends to improve with a dedicated knowledge base tool, which offers more control over the content, style guides, and other elements.
- Transitioning to a dedicated knowledge base can help reduce the workload of documentation for developers. However, it is important to keep them involved in the process.
- “The most important factor that must be considered when switching from docs as code to a dedicated knowledge base tool is ownership and the review process. You need to ensure that developers are involved in the review process.
- Another key factor to take into account is the style guide. It helps to eliminate inconsistent style across the documentation, allowing different authors who contribute to the documentation to maintain consistency, regardless of the topic”, says Brianne.
- While discussing the collaborative approach, Brianne explains, “In our company, we have a small product that allows clients to interact with the main product through Python, which facilitates collaboration between developers and implementation managers. By continuing to use docs as code and rendering it into our documentation site, we maintain a collaborative approach and involve clients in the documentation process.”
- In the future, technical writing will likely merge with UX writing, with documentation getting fully integrated into software products. This integration will allow clients to access it without leaving the product interface.
Rapid fire with Brianne Bennett
- Highly recommended resource
Docs-as-ecosystem, a book by Alejandra Quetzalli and passo.uno blog by Fabrizio Ferri Benedetti
- One word that comes to your mind when you hear documentation.
Guide
- A piece of advice you would give your 20-year-old self
Trust yourself
Subscribe to Knowledgebase Ninjas:
–