doc-coauthoring

Guide structured three-stage co-authoring for documentation, proposals, and technical specs.

4|Updated Apr 25, 2024
One-click install
npx skills add https://github.com/BridgingIT-GmbH/bITdevKit.Examples.GettingStarted --skill doc-coauthoring-bridgingit-gmbh
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-coauthoring
Source: https://github.com/BridgingIT-GmbH/bITdevKit.Examples.GettingStarted/tree/main/.opencode/skills/doc-coauthoring
Command: npx skills add https://github.com/BridgingIT-GmbH/bITdevKit.Examples.GettingStarted --skill doc-coauthoring-bridgingit-gmbh

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill guides users through a structured, collaborative process to write documentation, proposals, technical specs, or decision records. It helps transfer context, refine content through iteration, and verify readability before publication.

Core Features & Use Cases

  • Three-stage workflow: Context Gathering, Refinement & Structure, and Reader Testing to ensure clarity and completeness.
  • Active guidance: Acts as a collaborative partner, asking clarifying questions and proposing section ideas.
  • Versioned drafting: Supports iterative drafting with structured feedback loops to converge on a reader-friendly document.

Quick Start

Initiate the co-authoring workflow when the user requests to write a document. Begin with Stage 1: Context Gathering, asking clarifying questions and collecting context before drafting.

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 collaboratively?

Co-author technical documentation collaboratively by using a three-stage workflow: Context Gathering, Refinement & Structure, and Reader Testing. This structured process captures context, iteratively refines content, and verifies reader comprehension before publication.

What is the best way to write a technical spec or decision doc with an AI?

The best way to write a technical spec or decision doc is through active guidance that asks clarifying questions and proposes section ideas. This collaborative method supports versioned drafting with structured feedback loops to converge on a reader-friendly document.

How do I verify reader comprehension before publishing a proposal?

Verify reader comprehension before publishing a proposal during the Reader Testing stage. This final workflow phase checks readability and ensures the audience understands the refined content, confirming clarity and completeness prior to release.

Can I use this structured writing workflow for proposals and technical specs?

Yes, you can use this structured writing workflow for proposals and technical specs. The co-authoring process is applicable to writing documentation, proposals, technical specs, and decision records, enabling context capture and iterative editing across various document types.

What are the stages of collaborative document co-authoring?

The stages of collaborative document co-authoring are Context Gathering, Refinement & Structure, and Reader Testing. They structure prompts, guide edits, and verify reader comprehension to ensure the final documentation is clear and complete.