Stop using tables for documenting configuration properties
- Published
- Author
David GarciaPrincipal consultant
An alternative to tables for documenting complex configuration properties and parameters.
Read more- The Software Documentation Blog
Insights into technical writing, developer experience, and docs as code.
How to enable documentation pull request previews in GitHub
- Published
- Author
- David GarciaPrincipal consultant
Simplify documentation pull request previews with PushPreview, ensuring up-to-date documentation without manual builds.
Read moreStrategies for improving technical documentation through user feedback
- Published
- Author
- David GarciaPrincipal consultant
This article discusses effective strategies for enhancing technical documentation through user feedback, emphasizing proactive engagement and iterative refinement.
Read moreManaging screenshots in documentation like a designer
- Published
- Author
- David GarciaPrincipal consultant
Learn practical strategies to manage screenshots in documentation efficiently, inspired by professional design practices.
Read moreA practical introduction to Documentation as Code
- Published
- Author
- David GarciaPrincipal consultant
A practical introduction to Documentation as Code, covering techniques and tools like GitHub, reStructuredText, Sphinx, ReadTheDocs, and Vale for maintaining up-to-date and enjoyable documentation projects.
Read moreHow to convert an OpenAPI document to MarkDown
- Published
- Author
- David GarciaPrincipal consultant
Learn how to convert OpenAPI 3.0 definitions to Markdown using Widdershins CLI for streamlined integration with static site generators like Docusarus and Sphinx.
Read more5 common software documentation localization mistakes
- Published
- Author
- David GarciaPrincipal consultant
This article discusses common mistakes in software documentation localization and how to avoid them, from setting clear language goals to maintaining consistency and managing version control effectively.
Read moreHow to split a large OpenAPI document into multiple files
- Published
- Author
- David GarciaPrincipal consultant
Learn how to split a large OpenAPI document into modular files for better organization and maintainability, with practical steps and a sample project repository provided.
Read moreTips for keeping documentation code examples up to date
- Published
- Author
- David GarciaPrincipal consultant
Discover how to maintain accurate and functional your documentation code examples on every release.
Read moreLet's talk about docs.
Do you want to create great products for technical audiences? Dive into the topic with our articles on technical writing, developer experience, and Docs as Code.