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

Documentation #8

Open
canadaduane opened this issue Mar 3, 2021 · 1 comment
Open

Documentation #8

canadaduane opened this issue Mar 3, 2021 · 1 comment

Comments

@canadaduane
Copy link
Member

canadaduane commented Mar 3, 2021

We should update the readme and potentially provide better documentation all around.

Three insights on documentation that might be helpful here, taken from various communities:

  1. A (short) synopsis of the architecture can be helpful, even if the details aren't documented. This doesn't have to take a lot of time, and if short, can be changed easily as refactorings take place.

  2. Documentation has four quadrants: practical<->theoretical and studying<->working. In the early stages of a project, it can be useful to focus on the "Discussions" (theoretical/studying) quadrant in order to help others understand, but without the burden of writing or maintaining tutorials, references, or how-to guides.

  3. "How Docs vs. Why Docs". The key insight here is that "why" is slow to change, whereas "how" is an evolving target.

@toomim
Copy link
Member

toomim commented Mar 3, 2021

I agree. Documenting the architecture is high priority. I expect to take a pass on that within 10 days.

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