doc-coauthoring

Guide structured documentation co-authoring through Context Gathering, Refinement, and Reader Testing.

7|Updated Feb 15, 2017
One-click install
npx skills add https://github.com/cedi/dotfiles --skill doc-coauthoring-cedi
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-coauthoring
Source: https://github.com/cedi/dotfiles/tree/main/.claude/skills/documentation
Command: npx skills add https://github.com/cedi/dotfiles --skill doc-coauthoring-cedi

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides a structured workflow to co-author documentation, guiding teams through a disciplined process to produce clear, reader-focused content.

Core Features & Use Cases

  • Three-stage workflow: Context Gathering, Refinement & Structure, and Reader Testing.
  • Diataxis-aligned guidance: Helps categorize output as Tutorial, How-to Guide, Explanation, or Reference.
  • Iterative refinement: Supports staged drafting, reviews, and validation with readers to ensure clarity.

Quick Start

Start by defining your document goal and the audience, then run through Context Gathering, Structuring, and Reader Testing to produce a cohesive document.

Frequently Asked Questions about doc-coauthoring

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What is a structured co-authoring workflow for technical documentation?

Structured co-authoring guides teams through Context Gathering, Refinement & Structure, and Reader Testing to produce clear, reader-focused technical documentation, proposals, and specs.

How do I use the Diataxis framework to write technical documentation?

Apply a Diataxis-aligned approach by categorizing document drafts as Tutorials, How-to Guides, Explanations, or References, using stage-specific prompts and artifacts to ensure reader-focused outcomes.

What is the best way to co-author proposals and decision records with a team?

Use an iterative workflow featuring staged drafting, structured reviews, and reader validation to co-author cohesive proposals and decision records while ensuring content clarity.

How do I gather context and structure technical specs during co-authoring?

Define document goals and audience first, then progress through structured refinement stages and reader testing to gather context and produce cohesive technical spec outputs.

Does this co-authoring workflow support reader testing for documentation?

Yes, the workflow includes a dedicated Reader Testing stage to validate drafts with readers, ensuring final documentation achieves intended reader-focused outcomes and clarity.