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.
There are many reasons why an engineer should improve writing. Having more influence in the organization or scaling the existing knowledge are just some of them.
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
Writing a personal worklog is a useful technique that helps you store knowledge that you get as you work through challenges in the project. It serves as a personal knowledge base which means that you don’t have to solve the same problem twice.
If our company reaches a point where the product is too big to keep in mind how it works, more teams need to be introduced. This usually results in incorrect knowledge distribution. According to Conway’s law the system will eventually adapt to the new organization structure. But until this is achieved, people can become frustrated and leave. We can act proactively by identifying gaps and reducing them. A tool that can help us with that task is the team knowledge matrix