Ensure documentation content matches its intended audience and location. High-level documentation like README files should focus on essential information for the primary audience, while detailed technical information should be placed in developer-specific documentation. Avoid adding overly detailed or redundant information that may confuse or overwhelm...
Ensure documentation content matches its intended audience and location. High-level documentation like README files should focus on essential information for the primary audience, while detailed technical information should be placed in developer-specific documentation. Avoid adding overly detailed or redundant information that may confuse or overwhelm readers.
Consider these guidelines:
For example, instead of adding detailed directory structure to a README:
### Codebase structure
├──app // The app frontend
├──bin // Scripts for running and hosting Mastodon
├──config // Code files relating to federated hosting
Consider whether this information is necessary for the README’s audience, or if it would be better placed in a dedicated developer documentation file.
Enter the URL of a public GitHub repository