doc-coauthoring

Guide collaborative documentation through staged drafting and reader-testing checks.

199|41|Updated Oct 25, 2020
One-click install
npx skills add https://github.com/rvdbreemen/OTGW-firmware --skill doc-coauthoring-rvdbreemen
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-coauthoring
Source: https://github.com/rvdbreemen/OTGW-firmware/tree/main/.github/skills/doc-coauthoring
Command: npx skills add https://github.com/rvdbreemen/OTGW-firmware --skill doc-coauthoring-rvdbreemen

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It helps users produce documentation that is easier for others to understand by guiding them through context capture, structured refinement, and reader-focused testing.

Core Features & Use Cases

  • Context Gathering with clarifying questions: collects doc type, audience, goals, constraints, and all relevant background so the draft doesn’t assume hidden knowledge.
  • Iterative refinement by section: turns vague ideas into a coherent outline and then drafts each section through options, curation, and gap checks.
  • Reader Testing with a fresh perspective: validates that the resulting document works when read without conversation context, catching ambiguities and blind spots before publication.
  • Artifact/file scaffold support: creates a structured draft scaffold (when supported) so collaboration can start immediately.

Quick Start

Tell the AI: "I need help drafting a design decision document for my team; follow the doc co-authoring workflow and start by asking me the context-gathering questions."

Frequently Asked Questions about doc-coauthoring

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

FAQPage Schema
How do I co-author technical specs so they make sense to readers who lack my prior context?

To draft a design doc that works without hidden context, use a staged workflow that first captures audience and constraints, then refines the outline section-by-section, and finally runs reader-testing checks to expose ambiguities before publication.

What is the best way to structure an RFC or PRD for iterative refinement?

Structure an RFC or PRD by turning vague ideas into a coherent outline, then draft each section through iterative refinement using options, curation, and gap checks to validate all missing assumptions before review.

How does reader testing improve structured writing for decision records?

Reader testing improves decision records by validating the document from a fresh perspective, catching blind spots and ambiguities that authors miss, ensuring the draft communicates clearly without requiring verbal explanation.

Can I use this workflow to draft a design decision document for my team?

Yes, you can draft a design decision document for your team by initiating the workflow with context-gathering questions about doc type, audience, goals, and constraints, which builds a solid foundation for structured collaborative drafting.

Do I need any specific file format or environment to start co-authoring documentation?

No specific file format or environment is strictly required to start co-authoring documentation, though the workflow can generate a structured draft scaffold when supported by your environment to enable immediate collaborative drafting.

When should I not use a staged co-authoring workflow for structured documents?

Avoid a staged co-authoring workflow for simple, unstructured notes or quick memos that do not require iterative refinement, reader testing, or validation of complex technical assumptions across multiple stakeholders.