Skip to content

joseph-fajen/ai-coding-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AI Code Template

A project template that implements the essential directories for scaling AI engineering work:

  1. AI Docs: A persistent knowledge repository for AI tools
  2. Specs: Detailed plans and specifications for features
  3. .claude: Reusable prompts for agentic coding tools
  4. Examples: Practical workflows demonstrating how to use the template with AI tools

Directory Structure

ai-code-template/
├── ai-docs/
│   ├── third-party/
│   ├── conventions.md
│   └── architecture.md
├── specs/
│   └── template.md
├── .claude/
│   └── commands/
│       ├── context-prime.prompt
│       └── feature-prime.prompt
├── examples/
│   ├── README.md
│   └── feature_development.md
├── tools/
│   └── pocket-pick/
│       ├── db.js
│       ├── cli.js
│       └── README.md
└── README.md
  • ai_docs/: Store third-party API documentation, integration details, custom patterns, and conventions
  • specs/: Store detailed plans and specifications for features
  • .claude/commands/: Store reusable prompts for agentic coding tools
  • examples/: Practical workflow examples showing how to use the template with AI tools

How to Use This Template

  1. Clone this repository as a starting point for your new project
  2. Add project-specific documentation to the AI docs directory
  3. Write comprehensive spec plans in the specs directory
  4. Set up reusable prompts in the .claude/commands directory
  5. Prime the AI coding tool with the context of the codebase using the context priming prompt
  6. Write agentic plans for desired features in the specs directory
  7. Have the AI coding tool implement the plans
  8. Review the examples directory for practical workflows demonstrating these steps

Benefits

  • AI tools can understand your codebase better and faster
  • Scale your engineering work across codebases and time
  • Write self-validating loops in prompts to expand into full codebases
  • Create detailed plans for your AI tools to implement
  • Reuse prompts across sessions with your AI coding tools

For more information, see the documentation in each directory.

About

A template for AI-enhanced coding projects with organized infrastructure for AI documentation, feature specifications, reusable prompts, and workflow examples. Helps AI tools understand codebases better, scales engineering work, and streamlines implementation of detailed plans.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors