roddsrod/documentation-rules icon
public
Published on 4/29/2025
roddsrod/documentation-rules

Documentation Rules

Rules

Build & Development Commands - Include build instructions and environment setup steps in the README.

Testing Guidelines - Explain how to run tests locally and in CI. - Describe how to interpret test results.

Code Style & Guidelines - Keep inline comments relevant and minimal — prioritize clean code. - Use examples in code snippets to improve clarity.

Documentation Guidelines - Use consistent formatting (Markdown or reST). - Include usage examples for all CLI tools, scripts, or libraries. - Link to upstream documentation when relying on 3rd-party libraries. - Prefer “why it exists” over “what it is” when explaining modules.