docs-style

What This Skill Does

The docs-style skill acts as an automated editor and style guide for technical documentation. It enforces high-quality writing standards by applying principles of active voice, second-person address, and concise phrasing. By integrating this skill into your OpenClaw workflow, you ensure that every document you produce—whether it is an API reference, a tutorial, or a README—remains professional, consistent, and highly readable for both human developers and LLMs.

Installation

You can install this skill directly via the ClawHub command line interface. Execute the following command in your terminal:

clawhub install openclaw/skills/skills/anderskev/docs-style

Once installed, you can invoke the documentation assistant by tagging it in your workspace or calling it via the OpenClaw API to review drafts or generate new content snippets based on the established style guide.

Use Cases

• Technical Review: Pass existing draft documentation through this skill to receive feedback on sentence structure, tone consistency, and adherence to technical writing best practices.
• Boilerplate Generation: Use the skill to scaffold documentation structures, ensuring that every page follows the 'self-contained' requirement with clear prerequisites and headings.
• Voice Correction: Automatically refactor passive, verbose text into direct, second-person prose that is optimized for developer adoption.
• Consistency Checks: Standardize terminology and formatting across a large repository of files by running the skill across your documentation library.

Example Prompts

1. "Review this paragraph for my API docs. It currently uses passive voice and feels too wordy: [insert text]."
2. "Generate a documentation template for a new integration skill that follows the docs-style principle of being self-contained."
3. "Rewrite these installation instructions to address the reader directly and use active verbs for every step."

Tips & Limitations

To get the best results, provide clear context regarding your audience and the specific technology being documented. While the skill is excellent at enforcing grammar and stylistic patterns, it cannot verify the technical accuracy of your code or API endpoints. Always perform a final technical validation of your generated content to ensure that code snippets are functional and that prerequisites are factually correct. Use it as a stylistic partner, not a subject matter expert.