Documentation Standards

1. Understand the Documentation Standards

   Familiarize Yourself with Style Guides: Understand the documentation's style guide, including language tone, formatting norms, and technical jargon usage.

   Follow Structural Guidelines: Adhere to the existing structure and organization of the documentation.

2. Review Existing Content Before Contributing

   Avoid Duplications: Ensure your contribution doesn’t duplicate existing content.

   Consistency: Check for consistency with related topics or sections.

3. Clear and Concise Writing

   Be Brief and to the Point: Avoid unnecessary verbosity. Aim for clarity and brevity.

   Use Simple Language: Prefer plain language over technical jargon unless necessary.

4. Technical Accuracy

   Fact-check: Double-check your technical information for accuracy.

   Stay Current: Make sure the information aligns with the latest version of the product or technology.

5. Use Examples and Visuals When Appropriate

   Relevant Examples: Include examples that are relevant and easy to understand.

   Visual Aids: Use diagrams, screenshots, or videos to enhance understanding, especially for complex topics.

6. Peer Review and Feedback

   Seek Peer Review: Before submitting, have your work reviewed by peers for an additional quality check.

   Be Open to Feedback: Be receptive to feedback and willing to make necessary revisions.

7. Properly Cite Sources

   Cite External Sources: If you use information or quotes from external sources, make sure to cite them properly.

8. Test Your Instructions or Code

   Verify Instructions: If your contribution includes instructions or procedures, test them to ensure they work as intended.

   Code Snippets: If applicable, ensure code snippets are accurate, simple, and tested.

9. Update Documentation Regularly

   Keep Information Up-to-date: Regularly review and update your contributions to keep them current with the latest updates or changes.

10. Engage with the Community

    Respond to Feedback: Engage with the community by responding to comments or queries regarding your contributions.

    Collaborative Attitude: Be willing to collaborate with others to improve the quality of the documentation.

11. Document the Reason for Changes

    Provide meaningful context and detail: When making changes, especially revisions, detail the reasons for the change in the Pull Request to provide context.

12. Use Inclusive Language

    Use Inclusive Language: Ensure your language is inclusive and does not discriminate against any group of people.