doc-coauthoring

Guide structured documentation co-authoring through context gathering, refinement, and reader testing.

1|Updated Sep 21, 2022
One-click install
npx skills add https://github.com/mohamedhabibwork/mohamedhabibwork --skill doc-coauthoring-mohamedhabibwork
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-coauthoring
Source: https://github.com/mohamedhabibwork/mohamedhabibwork/tree/main/habib-app/.opencode/skills/doc-coauthoring
Command: npx skills add https://github.com/mohamedhabibwork/mohamedhabibwork --skill doc-coauthoring-mohamedhabibwork

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Guides users through a structured workflow for co-authoring documentation, helping writers organize context, iterate content, and verify reader comprehension.

Core Features & Use Cases

  • Context Gathering: Collects project context, audience, and constraints before drafting.
  • Refinement & Structure: Iteratively builds and refines document sections for clear, coherent structure.
  • Reader Testing: Validates drafts with a fresh perspective to reveal gaps and ambiguities.
  • Use Case: Ideal for creating proposals, PRDs, design docs, RFCs, or decision papers with a repeatable process.

Quick Start

Begin Stage 1 by sharing your document context and goals so the assistant can ask clarifying 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 documentation like PRDs and design docs?

To co-author technical documentation, you start by sharing project context and goals. The workflow then guides you through context gathering, iterative refinement of document structure, and reader testing to validate comprehension.

What is the best way to structure a collaborative proposal writing workflow?

A structured collaborative proposal workflow separates context gathering, structural refinement, and reader testing. This ensures all project constraints are collected before drafting, resulting in clear and coherent document sections.

How does reader testing work when creating decision logs or RFCs?

Reader testing for decision logs uses sub-agents to validate drafts with a fresh perspective. This testing mechanism reveals gaps and ambiguities in the documentation, ensuring the target audience comprehends the technical decisions accurately.

Can I use this workflow for iterative drafting of knowledge transfer documents?

Yes, you can use this workflow for iterative drafting of knowledge transfer documents. It supports artifact scaffolding and structured workflow orchestration, allowing you to iteratively build and refine content for effective knowledge transfer.

Do I need to prepare project context before starting the co-authoring process?

You need to prepare project context, audience details, and constraints before starting the co-authoring process. Gathering this information upfront allows the workflow to ask targeted clarifying questions and scaffold the document effectively.

What are the limitations of using a structured workflow for editorial content creation?

A structured workflow for editorial content creation is designed for formal documents like proposals and design docs. It may not suit informal content where the rigid stages of context gathering, refinement, and reader testing are unnecessary.