doc-coauthoring

Guide documentation co-authoring through context gathering, refinement, and reader testing.

Updated Jul 2, 2025
One-click install
npx skills add https://github.com/janpeterd/dotfiles --skill doc-coauthoring-janpeterd
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-coauthoring
Source: https://github.com/janpeterd/dotfiles/tree/main/dot_agents/skills/doc-coauthoring
Command: npx skills add https://github.com/janpeterd/dotfiles --skill doc-coauthoring-janpeterd

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Guides co-authoring of documentation so the final draft is coherent for readers, not just for the author, by iteratively gathering context, structuring content, and validating clarity with reader-style testing.

Core Features & Use Cases

  • Context Gathering with Clarifying Questions: Collects essential meta-context (audience, template/format, impact, constraints) and supports info-dumps to close knowledge gaps before drafting.
  • Refinement & Structure in Iterations: Breaks the document into sections, then brainstorms, curates, drafts, and surgically refines each section based on user decisions.
  • Reader Testing (Fresh Perspective): Predicts likely reader questions and (when possible) tests the draft with a fresh Claude/no-context approach to catch ambiguity and missing assumptions.
  • Use Cases: Writing PRDs, design docs, RFCs, decision docs, proposals, and other structured technical or organizational writing where context transfer and clarity are critical.

Quick Start

Say: “I want help co-authoring a design doc—start with Stage 1: Context Gathering—ask me the initial questions.”

Frequently Asked Questions about doc-coauthoring

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

FAQPage Schema
How do I write a technical design doc from rough ideas?

To write a technical design doc from rough ideas, use a three-stage co-authoring workflow that gathers context, refines sections iteratively, and validates clarity through reader testing to produce a structured, reader-ready draft.

What is reader testing for technical documentation?

Reader testing for technical documentation is a validation stage that predicts likely reader questions and uses a fresh, no-context perspective to catch ambiguity and missing assumptions in your draft before finalizing it.

How do I structure a PRD or RFC iteratively without losing coherence?

Structure a PRD or RFC iteratively by breaking the document into individual sections, then brainstorming, curating, drafting, and surgically refining each section based on user decisions to maintain overall coherence.

Can I use an info-dump to start co-authoring a decision doc?

Yes, you can start co-authoring a decision doc with an info-dump, because the context gathering stage collects essential meta-context like audience and constraints while supporting unstructured knowledge dumps to close gaps before drafting.

Does this co-authoring workflow work for proposals and organizational writing?

Yes, this co-authoring workflow works for proposals and organizational writing, because it applies to any structured technical writing where context transfer, clarity, and iterative refinement are critical for the final audience.

What is the best way to ensure a technical spec is clear for readers and not just the author?

The best way to ensure a technical spec is clear for readers is to apply a structured co-authoring process that validates the draft using reader-style testing, catching ambiguity that the author would naturally overlook.