structured-doc-writing

Writes long research-based Markdown documents through staged brief, evidence, outline, section, and review artifacts.

Updated Oct 14, 2024
One-click install
npx skills add https://github.com/tktcorporation/food-shop-search --skill structured-doc-writing-tktcorporation
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: structured-doc-writing
Source: https://github.com/tktcorporation/food-shop-search/tree/main/.claude/skills/structured-doc-writing
Command: npx skills add https://github.com/tktcorporation/food-shop-search --skill structured-doc-writing-tktcorporation

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve? Writing a long research-based document in one pass often produces structural confusion, duplicated claims, and unsupported filler. This Skill splits document creation into separate stages—purpose definition, evidence collection, outline design, section-by-section drafting, and review—so each artifact is approved before the next stage begins. ## Core Features & Use Cases - Staged workflow with approval gates: Produces brief.md, evidence.md, outline.md, per-section files, draft.md, and final.md, blocking drafting until the outline is approved. - State-tracking CLI: A bundled Bun/TypeScript CLI (docflow.ts) initializes projects, validates placeholders, detects post-approval edits via hashes, assembles sections, and finalizes documents. - Structured review process: Reviews structure, evidence, and readability separately, recording each finding with its adoption decision. - Use Case: When writing a quarterly retrospective or design document based on investigation data, initialize a docflow project, log sourced facts in evidence.md, design the outline, then draft and review one section at a time. ## Quick Start Ask the AI to use the structured-doc-writing skill to plan and write a research report, starting by initializing a docflow project with a title and defining the brief.

Frequently Asked Questions about structured-doc-writing

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

FAQPage Schema
How do I write a long research document without structural confusion?▼

Split the work into stages: define the brief, collect sourced evidence, design an outline with each section's question and conclusion, then draft one section at a time. This Skill enforces that order with approval gates so drafting cannot start before the outline is approved.

How to enforce an outline-first writing workflow with a CLI?▼

Run the bundled docflow CLI with Bun: init creates the project artifacts, approve validates each stage, add-section requires an approved outline, and assemble combines approved sections into draft.md. Post-approval edits are detected via content hashes and require re-approval.

What runtime does the docflow CLI require?▼

The docflow CLI is a TypeScript script executed with Bun (bun docflow.ts). It uses only Node.js built-in modules such as fs, crypto, and path, so no external npm packages need to be installed.

When should I not use a staged document-writing workflow?▼

Avoid it for short answers or localized edits to existing documents, where the overhead of brief, evidence, and outline stages adds no value. The Skill's own description explicitly excludes those cases.

Why does docflow approval fail after I edit an approved file?▼

The CLI stores a SHA-256 hash of each artifact at approval time. If the file changes afterward, the hash no longer matches, status shows the stage as changed, and downstream approvals are blocked until you re-approve the edited artifact.