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

Codify guidelines about how this documentation works #3

Open
underscorefunk opened this issue Nov 27, 2022 · 0 comments
Open

Codify guidelines about how this documentation works #3

underscorefunk opened this issue Nov 27, 2022 · 0 comments

Comments

@underscorefunk
Copy link
Owner

Add a readme with some details to set context for these docs.

  1. These docs will try to follow the same principles we follow when writing applications.
  • We can't use ideas that aren't brought into scope
  • We must define all ideas in the system if they're being discussed
  • Employ stratified design of layers of understanding
  1. Assume no prior knowledge
  2. Express the context in which the documentation is being written, and who it's being written for. The implications of this should be made clear to the reader.
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

1 participant