doc-coauthoring

Guide users through a three-stage co-authoring workflow for documentation.

Updated Mar 27, 2022

Search Tags:#workflow #documentation #collaboration #coauthoring #reader-testing #writing-process

Ready to run

npx skills add https://github.com/emliunix/home.conf --skill doc-coauthoring-emliunix

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: doc-coauthoring
Source: https://github.com/emliunix/home.conf/tree/main/skills/doc-coauthoring
Command: npx skills add https://github.com/emliunix/home.conf --skill doc-coauthoring-emliunix

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill guides users through a three-stage, structured workflow to co-author documentation. It enables efficient context transfer, iterative refinement, and reader testing to improve the quality and readability of docs like proposals, technical specs, decision documents, or similar artifacts.

Core Features & Use Cases

Stage-based guidance covering Context Gathering, Refinement & Structure, and Reader Testing.
Interactive clarifying questions and iterative drafting to build sections collaboratively.
Supports creating artifacts, templates, and structured workflows for docs such as PRDs, design docs, RFCs, and decision logs.
Optional collaboration aids, including staged reviews and reader testing to verify clarity with fresh perspectives.

Quick Start

Offer the three-stage co-authoring workflow and prompt the user to begin with Stage 1: 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 workflow for co-authoring technical documentation?▼

Structured co-authoring improves documentation by applying stage-based guidance for context gathering, iterative refinement, and reader testing, ensuring proposals and technical specs are clear and verified by fresh perspectives.

How do I start co-authoring a technical spec or PRD?▼

Start co-authoring a technical spec by initiating Stage 1: Context Gathering, where interactive clarifying questions transfer project background to collaboratively build the document foundation.

Can I use this workflow for writing an RFC or design doc?▼

Yes, the workflow adapts its three-stage co-authoring process to support creating templates and artifacts for RFCs, design docs, decision logs, and similar structured content.

Does the co-authoring process include reader testing for documentation?▼

Yes, the co-authoring process includes a Reader Testing stage to verify document clarity and readability by staging reviews with fresh perspectives before finalizing.

What is the best way to iteratively refine a proposal draft?▼

Iteratively refine a proposal draft using the Refinement & Structure stage, which provides stage-specific prompts to collaboratively build sections and structure content for decision documents.

Are there prerequisites for using a structured documentation workflow?▼

No strict technical prerequisites are required for this structured documentation workflow, as it operates without dependencies and needs only your raw context and ideas to begin the interactive drafting process.