How does the Reader Testing stage work?

It verifies the document's effectiveness by simulating a 'fresh' reader (usually via a sub-agent or manual check) to identify where information might be missing or confusing to someone without your specific project context.

What types of documentation patterns are supported?

The skill includes specialized scaffolds for READMEs, API documentation (OpenAPI), Architecture guides, Configuration tables, and Module-level documentation.

Can I use this for existing documentation updates?

Yes, the skill is designed for both creating new documents and refactoring existing ones, using surgical edits to update specific sections without rewriting the entire file.

What makes doc-coauthoring different from standard AI writing?

Instead of a single-shot generation, it uses a structured three-stage workflow—Context Gathering, Refinement, and Reader Testing—to ensure the documentation is tailored to the audience and free of blind spots.

Documentation Co-Authoring

Name: Documentation Co-Authoring
Author: joaquimscosta

byjoaquimscosta

•

Aprendizaje y Documentación

Guides developers through a structured, collaborative workflow to create high-quality technical documentation, READMEs, and architecture guides.

The doc-coauthoring skill transforms the documentation process by replacing basic text generation with a rigorous, multi-stage collaborative workflow. It bridges the gap between developer knowledge and reader needs by moving through context gathering, iterative refinement, and 'reader testing' stages. Whether you are drafting a complex RFC, a technical specification, or a project README, this skill uses domain-specific scaffolds and surgical editing to ensure your documentation is accurate, clear, and professionally structured while maintaining the developer's agency throughout the process.

Características Principales

01Streamlined variants specifically optimized for code-level documentation

02Reader Testing stage to identify blind spots in technical explanations

03Multi-stage collaborative workflow including context gathering and refinement

046 GitHub stars

05Surgical editing using str_replace to maintain document integrity

06Specialized scaffolding for READMEs, API specs, and architecture docs

Casos de Uso

01Creating technical RFCs and architecture decision records (ADRs)

02Drafting comprehensive READMEs and installation guides for new repositories

03Authoring API documentation and OpenAPI specifications from source code analysis

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add joaquimscosta/arkhe-claude-plugins doc-coauthoring

For use in Claude.ai and ChatGPT

Download Skill