skills.rest
tinywasm
tinywasmOFFICIAL
Explore all skills by this author →
GitHub

documentation

Define unified documentation standards for ARCHITECTURE.md, PLAN.md, DESIGN.md, SPECS.md, SKILL.md, diagrams, and README indexing.

1|Updated Dec 2, 2023
Search Tags:#design#planning#architecture#documentation#specifications#readme#standards
One-click install
npx skills add https://github.com/tinywasm/devflow --skill documentation-tinywasm
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/tinywasm/devflow/tree/main/skills/documentation
Command: npx skills add https://github.com/tinywasm/devflow --skill documentation-tinywasm

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Defines a unified documentation standard for ARCHITECTURE.md, PLAN.md, DESIGN.md, SPECS.md, SKILL.md, diagrams, and README indexing to ensure consistent, machine-friendly documentation across projects.

Core Features & Use Cases

  • Consistent structure: Enforces the same document set and layout for ARCHITECTURE.md, PLAN.md, DESIGN.md, SPECS.md, SKILL.md, and related diagrams.
  • Indexing rules: Mandates a comprehensive README index that surfaces all documentation files.
  • LLM-friendly guidelines: Ensures frontmatter and content are machine-readable for automated tooling and reviews.

Quick Start

Update or create ARCHITECTURE.md, PLAN.md, DESIGN.md, SPECS.md, SKILL.md, diagrams, and the README index following these standards.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I standardize project documentation for architecture and planning files?▼

Standardize project documentation by enforcing a unified structure for ARCHITECTURE.md, PLAN.md, DESIGN.md, and SPECS.md files. This ensures consistent, machine-readable layouts across architecture, planning, design, and reference materials.

What is the best way to make project README files LLM-friendly for automated tooling?▼

Make README files LLM-friendly by mandating a comprehensive index that surfaces all documentation files and specifying frontmatter expectations. This ensures content remains machine-readable for automated reviews and tooling.

How do I structure a project documentation set to certify a Skill Unit?▼

Structure a project documentation set by creating ARCHITECTURE.md, PLAN.md, DESIGN.md, SPECS.md, and SKILL.md files with required frontmatter. Include diagrams and a README index following specified rules to certify a Skill Unit.

What diagram placement rules are required for consistent project documentation standards?▼

Diagram placement rules require integrating visual references within the unified documentation standard for ARCHITECTURE.md and DESIGN.md. This ensures diagrams are consistently indexed and accessible alongside related planning materials.

Can I use custom file names for specifications and design docs while maintaining LLM-friendly documentation?▼

No, maintaining LLM-friendly documentation requires using specific file names like SPECS.md and DESIGN.md. The standard enforces required file names and frontmatter expectations to ensure consistent, machine-readable project documentation.

Related Skills

Explore More Content & Communication Skills→
paradox123paradox123

context-bootstrap

Collect repository structure, runnable commands, and architecture anchors at startup.

Community
Intermediate
projectedanxprojectedanx
1

design-md

Manage design tokens and component specifications in machine-readable DESIGN.md files.

Community
Intermediate
jiaxiaojunQAQjiaxiaojunQAQ
75

architecture-diagram-creator

Generate architecture diagrams from natural language prompts.

Community
Intermediate
lazygopherslazygophers
4

llms-skills

Define a standardized Markdown format for LLM-optimized project documentation.

Official
Basic