technical-writing

What This Skill Does

The technical-writing skill is a dedicated AI agent module designed to assist developers and technical writers in creating, maintaining, and refining high-quality documentation. It acts as an expert consultant for project documentation lifecycle management, covering everything from simple README files to complex OpenAPI/Swagger specifications and comprehensive tutorials. The skill enforces industry-standard formatting, such as 'Keep a Changelog' and Semantic Versioning, ensuring that your technical communication remains professional, consistent, and developer-friendly. It leverages a documentation-as-code philosophy, emphasizing clarity, structural integrity, and progressive disclosure to ensure users of your project can quickly understand and implement your tools.

Installation

To integrate this skill into your OpenClaw environment, execute the following command in your terminal: clawhub install openclaw/skills/skills/anton-abyzov/sw-technical-writing Once installed, you can trigger the skill by referencing technical documentation tasks in your agent prompts.

Use Cases

• API Documentation: Quickly generate JSDoc or Swagger-compliant documentation for your backend and frontend services.
• README Creation: Generate professional landing pages for open-source repositories that clearly define installation, usage, and contribution guidelines.
• Tutorial Development: Design step-by-step educational guides that help users get started with your platform in under 10 minutes.
• Changelog Maintenance: Automate the drafting of release notes, ensuring adherence to versioning standards and clarity for end-users.

Example Prompts

1. "Analyze my codebase and generate a README.md file that includes a quick start guide, feature list, and installation instructions."
2. "Review this TypeScript function and write a comprehensive JSDoc comment block including parameters, return types, and a clear usage example."
3. "Write a changelog entry for version 2.1.0, highlighting the performance improvements in our database connection pool and the bug fix for the authentication middleware."

Tips & Limitations

• Tips: Always provide the agent with the relevant code snippets or context for the best results. Use the skill to iterate; ask for 'more concise' or 'more beginner-friendly' versions if the initial draft is too complex.
• Limitations: The skill operates best when provided with source code or clear technical requirements. It is a text-generation tool and cannot automatically verify if documentation matches the live build state; manual verification of generated docs against your code is recommended.