DEV Community πŸ‘©β€πŸ’»πŸ‘¨β€πŸ’»

DEV Community πŸ‘©β€πŸ’»πŸ‘¨β€πŸ’» is a community of 966,155 amazing developers

We're a place where coders share, stay up-to-date and grow their careers.

Create account Log in
Cover image for Documentation near the code
SΓ‘vio Santos
SΓ‘vio Santos

Posted on

Documentation near the code

I encourage and venture to follow the following principles:

  • The code is more important than the documentation, but with time you will forget part of what you coded. So document from the beginning to get a high-level view of what you've done.

  • The code is more important than the documentation, but having the documentation will help anyone joining the project in the future. This will avoid the bus factor.

  • Using a specific documentation tool is cool, but if it's too far from the code, you might forget to update the documentation. So, bring the documentation as close to the code as possible.


Agile Manifest Topic 2: "Software at Work More Than Comprehensive Documentation." 
Enter fullscreen mode Exit fullscreen mode

Let's look for better ways to integrate code with documentation. Working software is important, but we still need documentation.


Examples of actions that directly or indirectly promote documentation close to the code:

Feedback is always welcome.

Github repo: https://github.com/savi8sant8s/documentation-near-the-code

Top comments (0)

Take a look at this:

Settings

Go to your customization settings to nudge your home feed to show content more relevant to your developer experience level. πŸ›