doc-coauthoring

Guide structured documentation creation through staged prompts and iteration loops.

7|Updated Nov 30, 2019
One-click install
npx skills add https://github.com/dstanberry/dotfiles --skill doc-coauthoring-dstanberry
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-coauthoring
Source: https://github.com/dstanberry/dotfiles/tree/main/ai/claude/skills/doc-coauthoring
Command: npx skills add https://github.com/dstanberry/dotfiles --skill doc-coauthoring-dstanberry

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This workflow provides a structured approach to co-authoring documentation, guiding users through gathering context, refining structure, and testing reader comprehension to improve clarity and alignment.

Core Features & Use Cases

  • Stage 1: Context Gathering — collect relevant background, constraints, and questions before drafting.
  • Stage 2: Refinement & Structure — iteratively build sections, brainstorm options, and curate content.
  • Stage 3: Reader Testing — validate the document with a fresh perspective to identify gaps and ambiguities.
  • Use cases include writing technical specs, proposals, design docs, decision records, and other structured documents.

Quick Start

Accept the co-authoring workflow and begin Stage 1 by answering the initial clarifying questions.

Frequently Asked Questions about doc-coauthoring

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

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

A structured co-authoring workflow guides users through staged documentation creation using context gathering, refinement, and reader testing to improve clarity and alignment on technical docs.

How do I start co-authoring a design spec or proposal?

Begin co-authoring by entering Stage 1, Context Gathering, where you answer clarifying questions to collect relevant background, constraints, and project requirements before drafting the document.

Can I use this co-authoring workflow for writing decision records?

Yes, the co-authoring workflow applies to writing decision records, technical specs, design docs, and proposals by guiding iterative section building and content curation across three structured stages.

What is the best way to test reader comprehension of a technical document?

The best way to test reader comprehension is Stage 3, Reader Testing, which validates the document with a fresh perspective to identify gaps, ambiguities, and unclear sections before finalizing.

How does iterative refinement work when co-authoring a document?

Iterative refinement happens during Stage 2, where you build document sections, brainstorm options, and curate content through explicit stage transitions and artifact-based collaboration feedback loops.

Are there limitations to using a staged documentation creation process?

The staged documentation process requires completing explicit stage transitions, meaning you cannot skip directly to drafting without first gathering context, which may slow highly informal or rapid note-taking tasks.