ai-context-writer

Generate and maintain ai-context.md documentation for modules with frontmatter.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/front-depiction/claude-setup --skill ai-context-writer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ai-context-writer
Source: https://github.com/front-depiction/claude-setup/tree/main/skills/ai-context-writer
Command: npx skills add https://github.com/front-depiction/claude-setup --skill ai-context-writer

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Creating and maintaining ai-context.md files for modules helps teams surface module context to AI assistants and discovery tools. This skill standardizes module documentation so internal and external references are easily discoverable via /modules commands.

Core Features & Use Cases

  • Automated ai-context.md generation: Produce standardized frontmatter (path, summary, tags) and a descriptive markdown body for modules found in packages/ or apps/ directories.
  • Module discovery and indexing: Ensure modules (internal packages/apps and external references) are indexed for quick lookup by the context crawler.
  • Documentation updates on refactor: Regenerate context files after significant changes to module interfaces or architecture.
  • Use Case: Add a new internal package and generate ai-context.md to appear in /modules; extend an external reference by documenting its submodule in ai-context.md.

Quick Start

Use the ai-context-writer to create documentation for a module, for example: ai-context-writer --path packages/my-package --summary "One-line summary of the module" --tags effect,ai,docs

Note: Ensure the generated file is named exactly ai-context.md at the module root.

Frequently Asked Questions about ai-context-writer

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

FAQPage Schema
How do I generate ai-context.md files for internal modules?

To generate ai-context.md files for internal modules, provide a module path, a concise summary, and optional tags to standardize module documentation so internal packages and apps are easily discoverable by the context crawler.

What is module discovery and indexing for AI assistants?

Module discovery and indexing is the process of standardizing ai-context.md files with frontmatter like path, summary, and tags to ensure internal packages and external references are indexed for quick lookup by AI assistants via commands like /modules.

Does ai-context documentation work for external module references?

Yes, ai-context documentation works for external module references by documenting its submodule in an ai-context.md file, ensuring it remains discoverable via the /module-search commands.

When should I regenerate module documentation?

You should regenerate module documentation after significant changes to module interfaces or architecture to ensure the context crawler and AI assistants have accurate, standardized context for the modified packages or apps.

What frontmatter is required for module indexing?

The frontmatter required for module indexing includes a module path, a concise summary, and optional tags, enforced by the ai-context-writer to ensure consistent indexing across internal and external modules.