jerelvelarde/chalk-skills

product-context-docs

Create and update in-repo product context documentation in /docs (product profile, features, sitemap, architecture, tech stack). Use when asked to document a product, bootstrap /docs structure, or refresh product/tech context docs for a repo.

First seen Mar 10, 2026

Installation

$ npx skills add jerelvelarde/chalk-skills --skill product-context-docs

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, Grep, Write, Edit

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 3,092 B
  • docs SUMMARY.md 270 B

History

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

SKILL.md

Product Context Docs

Overview

Use this skill to create or update product context documentation under /docs in the current repository. Keep the docs accurate, concise, and easy to scan, and preserve existing content when it is already correct.

Workflow

  1. Locate the repo root (use the current working directory unless told otherwise).
  2. Read existing context first: README.md, docs/ (if present), product briefs, and any architecture or design notes.
  3. Ask targeted questions only for missing essentials: product name, target users, key jobs-to-be-done, differentiators, primary user flows, core features, and any technical constraints.
  4. Ensure the folder structure exists: /docs/product and /docs/tech.
  5. Create or update the default doc set (see below). Reuse existing content and update deltas rather than rewriting everything.
  6. Cross-link the docs where helpful (e.g., features to architecture, sitemap to features).
  7. Call out assumptions explicitly and mark placeholders as TODO when information is missing.

Default Doc Set

Create or maintain these files as the minimum set:

  • /docs/product/product-profile.md (product summary, users, value, metrics)
  • /docs/product/product-features.md (feature list, scope, status)
  • /docs/product/sitemap.md (information architecture and core flows)
  • /docs/tech/architecture.md (system overview, components, data flows)
  • /docs/tech/tech-stack.md (languages, frameworks, infra, tooling)

Add additional docs only when requested or clearly needed (e.g., /docs/product/glossary.md, /docs/tech/security.md).

Templates

Use the templates in assets/templates/ as starting points. Copy the closest template into /docs/... and fill it with repo-specific details:

  • assets/templates/product-profile.md
  • assets/templates/product-features.md
  • assets/templates/sitemap.md
  • assets/templates/architecture.md
  • assets/templates/tech-stack.md

Writing Guidelines

  • Use Markdown with short sections, tables, and bullet lists.
  • Prefer concrete details over generic language.
  • Use Mermaid diagrams for architecture when it clarifies flows.
  • Keep each doc independently readable; repeat minimal context where needed.
  • Preserve correct existing content and only change what is outdated or missing.