34 lines
1.6 KiB
Markdown
34 lines
1.6 KiB
Markdown
|
# Documentation guidelines
|
||
|
|
|
||
|
|
This document defines the rules used to write documentation in order to make it more consistent.
|
||
|
|
|
||
|
|
This documentation is a living document and so are it's rules; you are free to propose changes but in the meantime, please stick to them.
|
||
|
|
|
||
|
|
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC 2119](https://www.rfc-editor.org/rfc/rfc2119/).
|
||
|
|
|
||
|
|
## File naming
|
||
|
|
|
||
|
|
Files SHOULD be named using [kebab-case](https://www.freecodecamp.org/news/snake-case-vs-camel-case-vs-pascal-case-vs-kebab-case-whats-the-difference/#kebab-case).
|
||
|
|
|
||
|
|
Their names should be meaningful and SHOULD not conflict with other files in other directories:
|
||
|
|
|
||
|
|
> Example: this document is named `docs/guidelines/documentation-guidelines.md` instead of `docs/guidelines/documentation.md` because it could cause confusion with `docs/documentation.md`.
|
||
|
|
|
||
|
|
## Documentation
|
||
|
|
|
||
|
|
When writing documentation, the author should have in mind it's target audience: people with varying technical skills and backgrounds, fluency in peer-to-peer-specific terms and mental ability. The documentation should therefore be acessible and usefule to most people interested in building, using and contributing to Tilde Friends.
|
||
|
|
|
||
|
|
### Terminology
|
||
|
|
|
||
|
|
`Tilde Friends` refers to the projectas a whole. This can be abbreviated to `TF`.
|
||
|
|
|
||
|
|
`tildefriends` refers to the program.
|
||
|
|
|
||
|
|
### Style guide
|
||
|
|
|
||
|
|
TODO
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
As per the rest of the code in this repository, the documentation is shared under the [MIT](https://opensource.org/licenses/MIT/) license.
|