jerelvelarde/chalk-skills

create-doc

Create a new doc file in .chalk/docs/ when the user asks to create, write, or add documentation

First seen Mar 10, 2026

Installation

$ npx skills add jerelvelarde/chalk-skills --skill create-doc

Similar popular skills

Related neighbors and high-traction skills in the same topics — useful to compare before installing.

Also in this package

Other skills from jerelvelarde/chalk-skills · top by installs.

npx skills add jerelvelarde/chalk-skills

Browse all from jerelvelarde/chalk-skills

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Not declared
Cursor Not declared
Codex Not declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Repository health

Stars 6
License LICENSE
Default branch main
Open issues 1
Status Active

Skill metadata

Parsed from SKILL.md frontmatter.

Version1.0.0
Allowed toolsRead, Glob, Write

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 2,709 B
  • docs SUMMARY.md 113 B

History

  1. First seen on skills.sh
  2. First recorded snapshot · 13 installs

SKILL.md

Create a new documentation file in .chalk/docs/.

Workflow

  1. Parse the request — Identify the target vertical and topic from $ARGUMENTS.
  2. Check existing docs — Read filenames in the target directory to find the highest numbered file. The next doc number is highest + 1.
  3. Draft the doc — Write substantive content, not stubs. Use the structure and tone guidelines below.
  4. Write the file — Save to .chalk/docs/<vertical>/<number>_<slug>.md.
  5. Confirm — Tell the user the doc was created with its path and a brief summary.

Verticals

Vertical Directory Use For
Product product/ Vision, strategy, user research, pricing, competitive analysis
AI ai/ Agent context, codebase orientation, prompt patterns, gotchas
Engineering engineering/ Architecture, conventions, APIs, runbooks, data flows
Root .chalk/docs/ Docs that don't fit a vertical

If the user specifies a vertical ("engineering doc about..."), use it. If ambiguous, infer from content: technical architecture -> engineering, product strategy -> product, agent context -> ai.

Filename Convention

<number>_<snake_case_slug>.md
  • Number is sequential within the vertical directory (profile docs are always 0_)
  • Slug is a short snake_case summary

Doc File Structure

# <Doc Title>

Last updated: <YYYY-MM-DD> (<brief change note>)

## <First Section>

Content...

## <Next Section>

Content...
  • No YAML frontmatter (docs are plain markdown)
  • First # Heading is the title
  • "Last updated" line immediately after the title
  • Use ## Heading for sections
  • All GFM features supported: tables, checkboxes, strikethrough, code blocks, Mermaid diagrams

Content Guidelines

Vertical Tone Focus
product/ Business-facing, concise What and why: user problems, strategy, metrics
ai/ Agent-facing, reference-style Where things are, how they work, gotchas
engineering/ Technical, comprehensive Architecture, conventions, APIs, data flows