You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Every product needs documentation and this could easily be represented as Markdown.
Interesting aspect of this type of documentation would be to be able to apply authorization to the different articles - as metadata and have them secured. This could mean that you could be targetting multiple audiences with content.
This is a super interesting aspect of the platform and product development in general. Good product documentation is super important, both from an end-user perspective, but also for internal support and builders of that product. One of the major hurdles is having an indication of how current documentation is compared to a version of the code. Far too often you end up reading documentation that no longer is valid.
When you have the documentation stored with the code repository, it should be a lot easier to link it to a version of the product.
Versioning documentation to a version of the code can also be hard. A lot of product documentation stabilizes over time and isn't connected to version upgrades, whereas other aspects evolve continuously. This could perhaps be solved by versioning documentation with the same or similar lines as with npm packages; ie: using ^*~. This could perhaps also be used to indicate when certain aspects of documentation are "evergreen" - useful for general articles or perhaps even development logs.
Regardless of the solution, I think this makes a lot of sense to explore 👍
Every product needs documentation and this could easily be represented as Markdown.
Interesting aspect of this type of documentation would be to be able to apply authorization to the different articles - as metadata and have them secured. This could mean that you could be targetting multiple audiences with content.
┆Issue is synchronized with this Asana task
The text was updated successfully, but these errors were encountered: