I’ve recently discovered that I can decrease the time to find relevant documentation with a single action: link related documents together.
Learn how to identify the audience of the documentation, so that it is more focused and structured without providing too much information.
Where should you keep your documentation?There are multiple options and it all depends on what you need to store, what tools are available for you, and what the skills in the team are.
When is the right moment to write documentation? That depends on the document type. Conceptual docs, release notes, testing scripts – they all fit differently into the software development cycle
There are multiple aspects to consider when choosing the right tool for the docs. I aim to provide questions that are worth asking.
Understanding how to choose the right document type is crucial to separate fast-changing documents from more stable ones. This will help you keep our documentation up-to-date