create-doc

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

Safety Notice

This listing is imported from skills.sh public index metadata. Review upstream SKILL.md and repository scripts before running.

Copy this and send it to your AI assistant to learn

Install skill "create-doc" with this command: npx skills add generaljerel/chalk-skills/generaljerel-chalk-skills-create-doc

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

VerticalDirectoryUse For
Productproduct/Vision, strategy, user research, pricing, competitive analysis
AIai/Agent context, codebase orientation, prompt patterns, gotchas
Engineeringengineering/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

VerticalToneFocus
product/Business-facing, conciseWhat and why: user problems, strategy, metrics
ai/Agent-facing, reference-styleWhere things are, how they work, gotchas
engineering/Technical, comprehensiveArchitecture, conventions, APIs, data flows

Source Transparency

This detail page is rendered from real SKILL.md content. Trust labels are metadata-based hints, not a safety guarantee.

Related Skills

Related by shared tags or category signals.

General

fix-review

No summary provided by upstream source.

Repository SourceNeeds Review
General

create-review

No summary provided by upstream source.

Repository SourceNeeds Review
General

create-handoff

No summary provided by upstream source.

Repository SourceNeeds Review
General

fix-findings

No summary provided by upstream source.

Repository SourceNeeds Review