doc-coauthoring

Organize collaborative documentation into a three-stage workflow with reader testing.

8|5|Updated Oct 15, 2024
One-click install
npx skills add https://github.com/TruvetaPublic/OpenToken --skill doc-coauthoring-truvetapublic
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-coauthoring
Source: https://github.com/TruvetaPublic/OpenToken/tree/main/.github/skills/doc-coauthoring
Command: npx skills add https://github.com/TruvetaPublic/OpenToken --skill doc-coauthoring-truvetapublic

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The Doc Co-Authoring Workflow guides users through a structured, three-stage process to create documentation, proposals, or technical specs with clearer context, iterative refinement, and reader validation.

Core Features & Use Cases

  • Stage-based guidance covering Context Gathering, Refinement & Structure, and Reader Testing.
  • Triggered when users mention writing docs, proposals, specs, RFCs, or similar documentation tasks.
  • Iterative collaboration with questions, brainstorming, curation, drafting, and refinements to ensure reader understanding.

Quick Start

Initiate Stage 1: Context Gathering for a new documentation task.

Frequently Asked Questions about doc-coauthoring

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I structure collaborative documentation across multiple teams?

Collaborative documentation is structured using a three-stage workflow: Context Gathering, Refinement & Structure, and Reader Testing. This enforces staged drafting and feedback loops to produce reader-ready documents, proposals, and specs.

What is the best way to co-author technical specs and get reader validation?

Co-authoring technical specs is best handled through iterative content creation and explicit reader testing stages. This approach applies questions, brainstorming, and refinements to ensure reader understanding before finalizing documents.

Can I use a structured workflow for writing RFCs and decision records?

Yes, you can use a frontmatter-driven structure and staged drafting workflow for writing RFCs and decision records. It triggers when you mention writing specs, RFCs, or similar documentation tasks across teams.

How does the reader testing stage work for proposals and technical documentation?

The reader testing stage works by applying explicit feedback loops to proposals and technical documentation. It validates reader understanding through iterative refinements after the Context Gathering and Refinement stages are complete.

Do I need frontmatter to draft proposals using a staged documentation workflow?

Yes, frontmatter is enforced to drive the structure of proposals and documentation. The workflow requires this frontmatter-driven structure to organize staged drafting and iterative collaboration effectively.