import { Callout } from "nextra/components";
**Purpose:** The How to Write (More) Docs section provides guidelines on how to extend the documentation of the Design System. It outlines what topics should be covered at both the component and foundations level, emphasizes the importance of clear and consistent vocabulary, suggests the use of illustrations and visual aids to enhance understanding, and highlights the significance of a well-organized information architecture. **Purpose:** The What to Cover topic provides guidance on what topics should be covered in the documentation of the Design System. It encourages comprehensive coverage of both individual components and foundational concepts. The goal is to provide users with a complete understanding of how to use and implement the Design System effectively.When documenting the Design System, consider covering the following:
- Component usage and behavior
- Styling and theming guidelines
- Accessibility considerations
- Design patterns and best practices
- Integration and implementation guides
- API documentation (if applicable)
- Troubleshooting and frequently asked questions
When writing documentation, adhere to the following guidelines:
- Define and explain key terms and concepts.
- Use consistent terminology throughout the documentation.
- Avoid jargon and technical language when possible.
- Provide clear and concise explanations.
Consider incorporating the following visual aids in your documentation:
- Diagrams or flowcharts to illustrate processes or interactions.
- Screenshots or images to showcase component examples.
- Icons or symbols to represent concepts or actions.
- Color-coded visuals to differentiate between states or variations.
When structuring your documentation, consider the following:
- Use a clear hierarchy with sections, sub-sections, and headings.
- Group related topics and components together.
- Provide navigation or table of contents for easy access.
- Use descriptive and concise titles for sections and headings.
References: