doc-coauthoring

Guide co-authoring workflows through Context Gathering, Refinement & Structure, and Reader Testing.

Updated Nov 22, 2024
One-click install
npx skills add https://github.com/creamgod45/CGCloud --skill doc-coauthoring-creamgod45
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-coauthoring
Source: https://github.com/creamgod45/CGCloud/tree/main/.agents/skills/doc-coauthoring
Command: npx skills add https://github.com/creamgod45/CGCloud --skill doc-coauthoring-creamgod45

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill guides users through a structured workflow to create clear, reader-friendly documentation with aligned context and iterative refinement.

Core Features & Use Cases

  • Three-stage collaborative workflow: Context Gathering, Refinement & Structure, Reader Testing.
  • Acts as an active guide to orchestrate co-authored documents, proposals, specs, or decision docs.
  • Helps ensure documents transfer context, refine content, and verify reader comprehension.

Quick Start

Offer the three-stage co-authoring workflow and begin 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 the best way to co-author technical documentation like proposals and specs?

Co-authoring technical documentation works best through a structured workflow of Context Gathering, Refinement & Structure, and Reader Testing to ensure proposals and specs are clear and reader-ready. This approach manages artifacts and iteration controls throughout the process.

How do I structure a workflow to refine a draft document into a decision doc?

To refine a draft into a decision doc, apply a three-stage workflow: gather context first, refine content and structure second, and perform reader testing third to verify comprehension and ensure the document transfers necessary context effectively.

How does reader testing help improve the quality of specifications?

Reader testing improves specifications by verifying reader comprehension at the final stage of the co-authoring workflow, ensuring the document successfully transfers context and handles typical document requirements without ambiguity before reaching the reader-ready state.

Can I use this co-authoring workflow for both proposals and technical specs?

Yes, you can use this co-authoring workflow for both proposals and technical specs because it guides users through context gathering, refinement, and reader testing to handle typical docs, satisfying requirements for entry points, stage guidance, and artifact management.

Do I need any specific tools or dependencies to start co-authoring documents?

No specific tools or dependencies are required to start co-authoring documents, as the skill acts as an active guide to orchestrate the workflow stages and manage artifacts directly within your current environment.

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

You should avoid using a structured co-authoring workflow for documentation when rapid, informal note-taking is needed, as the process enforces context gathering, refinement, and reader testing stages that add overhead unsuitable for quick drafts.