Get the FREE Ultimate OpenClaw Setup Guide →

create-doc

npx machina-cli add skill Vibe-Builders/claude-prime/create-doc --openclaw
Files (1)
SKILL.md
1.2 KB

Role

You are a documentation writer. Create docs based on what the user needs documented.

Process

1. Understand What to Document

  • Topic provided → use it
  • No topic → infer from conversation context
  • Unclear → ask user

2. Check Existing Docs

  • Check docs/ for related documents
  • Related doc exists → update it instead of creating new

3. Write Document

Use date +%Y%m%d%H%M for timestamp. Create: docs/{timestamp}-{topic-slug}.md

Write naturally — adapt structure to content. If the topic maps to a well-known document type (ADR, RFC, runbook, changelog, API doc, postmortem, etc.), follow its core layout in a lean way — just the essential sections, skip ceremony.

Good docs are:

  • Concise (bullets over prose)
  • Actionable (what to do next)
  • Contextual (why this matters)
  • Findable (clear title, good slug)

4. Confirm

  • Document path
  • What was captured

Constraints

  • Document facts, not speculation
  • Update existing docs when relevant
  • Don't duplicate content already in other docs

Topic

<topic>$ARGUMENTS</topic>

Source

git clone https://github.com/Vibe-Builders/claude-prime/blob/main/.claude/skills/create-doc/SKILL.mdView on GitHub

Overview

This skill acts as a documentation writer, creating guides, API docs, architecture docs, or project documentation tailored to user needs. It emphasizes concise, actionable, and contextual content to improve findability and clarity.

How This Skill Works

The skill identifies the topic, checks for existing docs, and then generates a timestamped Markdown document at docs/{timestamp}-{topic-slug}.md. It follows lean doc patterns (essential sections, bullets, and clear structure) and adapts to common types like API docs, ADRs, runbooks, or changelogs.

When to Use It

  • Document a new or updated API feature with a dedicated reference page
  • Capture architecture decisions, ADRs, or runbooks for operations
  • Create project-wide guides, tutorials, or onboarding docs
  • Update existing docs by linking to related files to avoid duplication
  • When topic is unclear, infer from conversation context and document accordingly

Quick Start

  1. Step 1: Determine the topic or request from the user
  2. Step 2: Check docs/ for related material and decide create vs update
  3. Step 3: Write and save as docs/{timestamp}-{topic-slug}.md with lean structure

Best Practices

  • Confirm the topic and scope with the user before writing
  • Scan docs/ for related material and update instead of duplicating
  • Use the timestamp format date +%Y%m%d%H%M for filenames
  • Write in concise bullets with a clear title and slug
  • Document facts only; avoid speculation and maintain consistency

Example Use Cases

  • docs/202406251230-api-authentication.md
  • docs/202406251315-architecture-cloud.md
  • docs/202406251400-runbook-deploy.md
  • docs/202406251430-api-doc-reference.md
  • docs/202406251515-onboarding-guide.md

Frequently Asked Questions

Add this skill to your agents
Sponsor this space

Reach thousands of developers