skills.rest
LeGeRyChEeSe
LeGeRyChEeSeCOMMUNITY
Explore all skills by this author →
GitHub

bmad-generate-project-context

Generate a project-context.md file documenting implementation rules for AI coding agents.

Updated Aug 25, 2024
Search Tags:#workflow#documentation#ai agents#project context#code conventions#bmad#coding rules
One-click install
npx skills add https://github.com/LeGeRyChEeSe/LanPlay-DiscordBot --skill bmad-generate-project-context-legerycheese
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: bmad-generate-project-context
Source: https://github.com/LeGeRyChEeSe/LanPlay-DiscordBot/tree/main/bmad/src/bmm-skills/3-solutioning/bmad-generate-project-context
Command: npx skills add https://github.com/LeGeRyChEeSe/LanPlay-DiscordBot --skill bmad-generate-project-context-legerycheese

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? AI coding agents often miss project-specific conventions, version constraints, and unobvious implementation rules, leading to inconsistent code. This Skill captures those critical rules in a single project-context.md file that agents read before writing code. ## Core Features & Use Cases - Guided Discovery: Scans architecture documents, package files, and configuration files to identify the technology stack, versions, and existing code patterns. - Collaborative Rule Generation: Walks through language, framework, testing, style, and workflow rule categories with the user, with optional advanced elicitation and party-mode review. - LLM-Optimized Output: Produces a lean, structured project-context.md with frontmatter tracking and usage guidelines for both agents and humans. - Use Case: A team onboarding AI coding assistants onto an existing TypeScript/React codebase uses this Skill to document linting rules, hooks conventions, and testing boundaries so every agent-generated change matches project standards. ## Quick Start Ask the AI to generate project context for this repository and follow the guided discovery and rule-generation steps.

Frequently Asked Questions about bmad-generate-project-context

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

FAQPage Schema
How do I create a project context file for AI coding agents?▼

Run the generate project context workflow, which discovers your technology stack from package files and architecture docs, then guides you through documenting language, framework, testing, and workflow rules into a project-context.md file.

What should a project context file for AI agents include?▼

It should include exact technology versions, language-specific rules, framework conventions, testing requirements, code quality standards, workflow patterns, and critical anti-patterns agents must avoid. The focus is on unobvious details agents would otherwise miss.

Does this workflow update an existing project-context.md file?▼

Yes. The discovery step checks for an existing project-context.md in the project, reads its sections, and offers to update or extend it rather than overwriting. Frontmatter tracks which sections have been completed.

How is the generated context file optimized for LLMs?▼

The finalization step removes redundant or obvious rules, consolidates related guidance into concise bullets, and enforces a consistent scannable structure. This keeps the file lean so it consumes minimal context window when agents load it.

When should I regenerate or review the project context file?▼

Regenerate it when the technology stack, dependencies, or coding conventions change. The workflow recommends periodic review to remove rules that have become obvious and to document newly emerged patterns.

Related Skills

Explore More Software Engineering Skills→
Asygnuz-S-A-SAsygnuz-S-A-S

bmad-create-architecture

Create software architecture decision documents through collaborative step-by-step workflow.

Official
Advanced
5onyy5onyy

bmad-generate-project-context

Generates a project-context.md file documenting technology stack and implementation rules for AI agents.

Community
Intermediate
TheBushidoCollectiveTheBushidoCollective
187

documentation-linking

Establish bidirectional links between code and documentation with multiple link formats.

Official
Basic
haipham22haipham22
2

golang-documentation

Audit and write Go documentation following godoc and llms.txt conventions.

Community
Advanced