Does this skill verify if the documentation matches the code?

Yes, the skill includes a preparation phase where it investigates relevant source code (primarily in the packages/ directory) to ensure the documentation is technically accurate.

Can it help with project formatting tools?

Yes, in the finalization phase, the skill can prompt to run project-specific commands like 'npm run format' to ensure consistent file formatting across the repository.

What is the primary purpose of the Docs Writer skill?

The Docs Writer skill is designed to handle all tasks involving writing, reviewing, or editing documentation, specifically for .md files and the /docs directory, ensuring they meet professional standards.

What formatting rules does it follow?

It enforces rules such as 80-character text wrapping, sentence case for headings, the use of serial commas, and the exclusion of tables of contents in favor of hierarchical headings.

Docs Writer

Name: Docs Writer
Author: plurigrid

byplurigrid

•

内容管理

Writes, reviews, and edits technical documentation according to strict style guides and project standards.

The Docs Writer skill transforms Claude into a senior technical editor tailored for complex software projects. It ensures all markdown files and documentation folders maintain a professional yet conversational voice, adhering to specific standards like 80-character text wrapping, active voice, and structured hierarchies. By following a rigorous four-phase process—Clarification, Investigation, Execution, and Verification—it guarantees that documentation is not only well-written but also technically accurate based on the actual codebase, making it an essential tool for maintaining high-quality project manuals and guides.

主要功能

01Enforces strict voice and tone standards including active voice and US English

02Manages markdown formatting including 80-character line wrapping and semantic HTML

03Integrates with project-specific formatting tools like npm run format

048 GitHub stars

05Cross-references codebase changes to ensure documentation accuracy

06Automates structural requirements like BLUF (Bottom Line Up Front) and hierarchical headings

使用场景

01Auditing existing documentation for stylistic consistency and broken links

02Generating new technical guides by analyzing source code in the repository

03Updating sidebar navigation and cross-references when project structures change

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add plurigrid/asi docs-writer

For use in Claude.ai and ChatGPT

Download Skill