doc-coauthoring

Guide writers through a structured multi-stage documentation co-authoring workflow.

203|9|Updated Dec 23, 2019
One-click install
npx skills add https://github.com/elianiva/dotfiles --skill doc-coauthoring-elianiva
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-coauthoring
Source: https://github.com/elianiva/dotfiles/tree/main/agents/skills/doc-coauthoring
Command: npx skills add https://github.com/elianiva/dotfiles --skill doc-coauthoring-elianiva

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Doc Co-Authoring Workflow helps users structure documentation projects to capture all relevant context, iteratively shape content, and validate readability for readers.

Core Features & Use Cases

  • Context Gathering: Collects meta-context, asks clarifying questions, and sets up integrations to pull in relevant inputs.
  • Refinement & Structure: Guides section-by-section drafting with brainstorming, curation, and iterative edits.
  • Reader Testing: Validates the draft with a fresh perspective to surface gaps and ensure clarity.
  • Trigger examples: when users mention writing docs, proposals, or specs, this workflow can be offered.

Quick Start

Offer the three-stage co-authoring workflow and start Stage 1 with Context Gathering.

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?

A structured co-authoring workflow guides writers through sequential stages of context gathering, iterative refinement, and reader testing to produce clear technical specs and proposals. It enforces clarifying questions and stage-based drafting to ensure coherence and coverage.

How do I start writing a technical design doc using a multi-stage workflow?

Start writing a technical design doc by initiating Stage 1: Context Gathering. This stage collects meta-context, asks clarifying questions, and sets up integrations to pull relevant inputs before moving into section-by-section refinement and drafting.

How do I validate readability and find gaps in a draft proposal?

Validate readability and find gaps in a draft proposal by applying a Reader Testing stage. This process surfaces missing context and clarity issues by evaluating the draft from a fresh reader perspective before final stakeholder review.

Can this iterative editing workflow handle long-form decision records?

Yes, this iterative editing workflow handles long-form decision records and technical specs by guiding section-by-section drafting with brainstorming and curation. It scales to accommodate complex documents requiring multi-stage context gathering and refinement.

What is the best way to gather context before writing stakeholder communication specs?

The best way to gather context for stakeholder communication specs is using a structured stage that collects meta-context and asks clarifying questions. This ensures all relevant inputs are integrated before iterative drafting begins.

When should I not use a stage-based documentation workflow?

You should not use a stage-based documentation workflow for short, informal notes or rapid updates that require immediate delivery. The enforced context gathering, iterative drafting, and reader testing stages add overhead best suited for long-form documents.