Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Look into formalizing product documentation #11

Open
einari opened this issue Sep 3, 2018 · 1 comment
Open

Look into formalizing product documentation #11

einari opened this issue Sep 3, 2018 · 1 comment
Milestone

Comments

@einari
Copy link
Contributor

einari commented Sep 3, 2018

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

@einari einari added this to the 2.0.0 milestone Sep 3, 2018
@pavsaund
Copy link
Contributor

pavsaund commented Sep 5, 2018

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 👍

@einari einari modified the milestones: 2.0.0, 2.2.0 Oct 21, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants