---

name: Writing Documentation description: Creating clear and effective documentation is essential for ensuring that AI agents can understand and work with software projects efficiently. This skill focuses on best practices for writing documentation that is both comprehensive and easy to follow.

Writing Documentation Skill

Overview

Creating clear and effective documentation is essential for ensuring that AI agents can understand and work with software projects efficiently. This skill focuses on best practices for writing documentation that is both comprehensive and easy to follow.

<default-conventions>

The default conventions to follow in any documentation

1. Always create markdown files (edit/createFile tool) for documentation.
2. Use subheadings (##, ###, etc.) to organize content into sections and subsections.
3. Use bullet points or numbered lists to break down complex information into digestible parts.
   1. Use numbered lists for sequential steps, long lists, nested lists, or when order matters.
   2. Use bullet points for non-sequential information.
4. Use nested lists for hierarchical information.
5. Use bold text to highlight important terms or concepts.
6. To show code snippets, use triple backticks () before and after the code block. Specify the language for syntax highlighting (e.g., py, ```js).
7. Use xml-style tags (e.g., <workflow>, <planning>, <searching-tools-instructions>) to denote special sections that may require specific formatting or instructions.
   1. Refer to these tags in the documentation to provide clarity on workflows, planning steps, or tool usage. Refer like this: <workflow>, <planning>, <searching-tools-instructions>.
8. Use 'edit/createFile to highly a tool name, file path, or any specific term related to the project.
   1. When referencing other documentation files, provide relative paths to ensure easy navigation.
9. Try to provide examples so that the reader can understand better.
10. Break lines between sections, titles, and paragraphs to improve readability.
11. Maintain a consistent tone and style throughout the documentation to ensure readability.

</default-conventions> <formatting-types>

What type of formatting ou should use?

First, you need to understand the concepts below, because each concept has its own formatting style.

• Contexts: reference
  • Description: These are instructions that provide additional information about the project, files, or specific scenarios so that the AI can understand the environment better.
  • It does not use other concepts directly.
• Docs: reference
  • Description: These are general documentation files that explain how to use, maintain, or contribute to the project.
  • It does not use other concepts directly.

</formatting-types> <skill-workflow-step-by-step-instructions>

Writing Documentation Workflow

1. Understand the main conventions to follow in any documentation from the <default-conventions> section.
2. Identify the type of documentation needed from the <formatting-types> section.
3. Create or update a documentation based on the provided user request.

</skill-workflow-step-by-step-instructions>