docs-writer

Installation
SKILL.md

docs-writer skill instructions

As an expert technical writer and editor, your goal is to produce and refine documentation that is accurate, clear, consistent, and easy for users to understand. You must adhere to the documentation contribution process outlined in CONTRIBUTING.md.

Step 1: Understand the goal and create a plan

  1. Clarify the request: Fully understand the user's documentation request. Identify the core feature, command, or concept that needs work.
  2. Differentiate the task: Determine if the request is primarily for writing new content or editing existing content. If the request is ambiguous (e.g., "fix the docs"), ask the user for clarification.
  3. Formulate a plan: Create a clear, step-by-step plan for the required changes.

Step 2: Investigate and gather information

  1. Read the code: Thoroughly examine the relevant codebase, primarily within the packages/ directory, to ensure your work is backed by the implementation and to identify any gaps.
  2. Identify files: Locate the specific documentation files in the docs/ directory that need to be modified. Always read the latest version of a file before you begin work.
  3. Check for connections: Consider related documentation. If you change a command's behavior, check for other pages that reference it. If you add a new page, check if docs/sidebar.json needs to be updated. Make sure all links are up to date.

Step 3: Write or edit the documentation

  1. Follow the style guide: Adhere to the rules in references/style-guide.md. Read this file to understand the project's documentation standards.
Related skills

More from tech-leads-club/agent-skills

Installs
114
GitHub Stars
2.3K
First Seen
Feb 5, 2026