Usage Guide
Learn detailed usage and best practices for AI Instruction Kits.
📖 Basic Usage
1. Using a Single Instruction
The simplest way to reference a specific instruction directly:
# For Claude
claude "Refer to instructions/en/coding/basic_code_generation.md and write code to generate Fibonacci sequence"
# For ChatGPT/Gemini (after uploading file)
"Follow the instructions to design a RESTful API"
2. Combining Multiple Instructions
Using ROOT_INSTRUCTION.md, AI automatically selects appropriate instructions:
claude "Refer to ROOT_INSTRUCTION.md to analyze sales data and create a report"
3. After Project Integration
After setup completion, simply use:
claude "Refer to CLAUDE.md and implement user authentication"
🎯 Effective Usage
Pattern 1: Step-by-Step Application
Process complex tasks in stages:
Step 1: Analyze data with instructions/en/analysis/basic_data_analysis.md
Step 2: Create report with instructions/en/writing/basic_text_creation.md
Step 3: Generate improvements with instructions/en/creative/basic_creative_work.md
Pattern 2: Role Distribution
Combine main and support instructions:
Main: instructions/en/coding/basic_code_generation.md
Support: instructions/en/general/basic_qa.md (for technical Q&A)
Pattern 3: Agent-based Approach
Act as specific experts:
claude "Refer to instructions/en/agent/python_expert.md
and optimize this Python code"
⚙️ Customization
Editing PROJECT.md
Add project-specific settings:
## Project-specific Additional Instructions
### Coding Standards
- ESLint config: Follow .eslintrc.js
- Naming convention: camelCase
- Comments: JSDoc format
### Test Requirements
- Coverage: 80% minimum
- E2E tests: Using Cypress
### Build Settings
- Build command: npm run build
- Lint command: npm run lint
- Test command: npm run test
Adding New Instructions
- Copy template:
cp templates/en/instruction_template.md instructions/en/[category]/my_instruction.md
-
Edit content
- Add to ROOT_INSTRUCTION.md (optional)
Organization Customization Example
# Internal Project Configuration
## Base Instructions
- instructions/en/coding/basic_code_generation.md
## Additional Rules
- Follow internal coding standards
- Comply with security guidelines
- Write comments in English
- Exclude confidential information
📊 Using Checkpoint Feature
Recording Work
Checkpoint feature automatically records:
# Recorded content
[timestamp][task ID][status] Task name (estimated steps)
[timestamp][task ID][COMPLETE] Result: Specific outcomes
# How to check
cat checkpoint.log
Visualizing Progress
# Completed tasks count
grep "COMPLETE" checkpoint.log | wc -l
# Today's work
grep "$(date +%Y-%m-%d)" checkpoint.log
# Check errors
grep "ERROR" checkpoint.log
🔍 Troubleshooting
Q: What if instructions conflict?
A: Prioritize more specific instructions. Specify priority in PROJECT.md.
## Instruction Priority
1. PROJECT.md (highest)
2. Task-specific instructions
3. Category instructions
4. Basic instructions
Q: What if instructions are too long?
A: Extract only necessary parts or create summary version.
# Use specific section only
"Refer to 'Error Handling' section in instructions/en/coding/basic_code_generation.md"
Q: How to mix languages?
A: Explicitly specify language for each instruction.
- Explain in English: instructions/en/general/basic_qa.md
- Code in comments: instructions/en/coding/basic_code_generation.md
🎯 Best Practices
1. Selecting Appropriate Instructions
- Choose most suitable instructions for the task
- Don’t use more instructions than necessary
- Combine with clear purpose
2. Managing Customizations
- Centralize in PROJECT.md
- Track changes with version control
- Share with team
3. Feedback Loop
- Evaluate usage results
- Continuously improve instructions
- Document best practices
📚 Learn More
- Features - Detailed feature explanations
- Quick Start - Get started in 5 minutes
- GitHub - Source code
💡 Tip
Start with basic instructions and gradually use advanced features as you become familiar with the system.