doc-coauthoring

Guide users through a three-stage co-authoring workflow from context gathering to reader testing.

1|Updated Nov 14, 2024
One-click install
npx skills add https://github.com/SangIlMo/.dotfiles --skill doc-coauthoring-sangilmo
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-coauthoring
Source: https://github.com/SangIlMo/.dotfiles/tree/main/.config/claude/skills/doc-coauthoring
Command: npx skills add https://github.com/SangIlMo/.dotfiles --skill doc-coauthoring-sangilmo

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Co-authoring is often slow and error-prone when teams fail to coordinate context, structure, and reader validation. This skill provides a structured three-stage workflow to guide users through context gathering, refinement & structure, and reader testing to produce coherent, reader-ready documentation.

Core Features & Use Cases

  • Stage-based guidance: Context Gathering to collect relevant context and questions; Refinement & Structure to draft sections iteratively; Reader Testing to validate readability with a fresh perspective.
  • Collaboration enablement: Facilitates iterative feedback, versioning, and alignment among writers, reviewers, and stakeholders.
  • Use Case: A product team wants to draft a PRD; the skill guides them from initial questions to a reader-tested document ready for review.

Quick Start

Initiate Stage 1 by gathering context with clarifying questions and a full context dump, then proceed through structured refinement and ending with reader testing.

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 collaborative documentation and technical specs?

A structured workflow for collaborative documentation guides teams through context gathering, structural refinement, and reader testing to produce coherent, reader-ready specs. It ensures alignment among writers and stakeholders by facilitating iterative feedback and versioning.

How do I start co-authoring a PRD with a team?

To start co-authoring a PRD, initiate context gathering by deploying clarifying questions and performing a full context dump. This initial stage collects necessary project details before progressing to iterative drafting and structural refinement.

What is the best way to validate readability for decision documents?

The best way to validate readability for decision documents is through a dedicated reader testing stage. This process evaluates the drafted content from a fresh perspective to ensure the final document is coherent and reader-ready before final review.

Does guided co-authoring support iterative drafting and versioning for proposals?

Yes, guided co-authoring supports iterative drafting and versioning for proposals. The workflow explicitly manages artifacts and facilitates iterative feedback, allowing writers and reviewers to refine sections continuously throughout the documentation process.

Can I integrate external reference scripts and assets into the documentation workflow?

Yes, you can integrate optional resources like scripts, references, and assets into the documentation workflow. The process supports managing these artifacts alongside iterative drafting to ensure all relevant context is incorporated into the final output.