AI Skill Report Card
Documenting Repository Structures
Quick Start12 / 15
Create a repository structure document:
Markdown# BLUEPRINT STRUKTUR REPOSITORY [PROJECT_NAME]
Recommendation▾
Reduce verbosity in workflow section - too much explanation of obvious steps like 'identify major functional areas'
Deskripsi Setiap Folder dan Subfolder dalam Bahasa Manusia.
1. `/core` — Inti Sistem
Folder ini berisi lapisan inti dari sistem operasi.
| Subfolder | Deskripsi |
|---|---|
kernel/ | Kernel OS: manajemen proses, memori, dan sumber daya |
governance/ | Tata kelola dan penegakan kebijakan sistem |
Workflow14 / 15
Progress:
- Map domain areas to top-level folders
- Document each major component group
- Detail subfolder responsibilities
- Create hierarchical table structures
- Add implementation notes and cross-references
- Review for duplicates and inconsistencies
Step 1: Domain Mapping
Identify major functional areas:
- Core system components
- User applications
- Services and daemons
- Infrastructure and deployment
- Documentation and governance
Step 2: Folder Documentation
For each top-level folder, create section with:
- Purpose statement (what the folder contains)
- Table of subfolders with descriptions
- Implementation notes for complex areas
Step 3: Hierarchical Tables
Use consistent table format:
Markdown| Subfolder | Deskripsi | |-----------|-----------| | `component_name/` | Penjelasan fungsi dalam bahasa Indonesia |
Step 4: Cross-Reference Analysis
Document relationships:
- Note duplicate components across folders
- Link related functionality
- Identify integration points
Recommendation▾
Make examples more concrete with actual input folder structures and complete output sections rather than fragments
Examples15 / 20
Example 1: Input: Operating system with AI governance layer
/core
/governance
/kernel
/security
/apps
/ecosystem
/internal
Output:
Markdownundefined
Recommendation▾
Streamline best practices and pitfalls sections - many points are basic software documentation knowledge Claude already has
1. `/core` — Inti Sistem (Lapisan OS)
Folder ini berisi semua lapisan inti dari MusGo-OS.
1.1 /core/governance — Tata Kelola dan Etika
| Subfolder | Deskripsi |
|---|---|
constitutional_runtime/ | Mesin yang menegakkan aturan konstitusi saat runtime |
Layer_00_Governor/ | Lapisan tertinggi: pengambil keputusan akhir |
**Example 2:**
Input: Microservices with UI separation
/services /networking /security /ui /web /mobile
Output:
```markdown
5. `/services` — Layanan Sistem
Layanan yang berjalan di latar belakang (daemon).
5.1 /services/networking
| Subfolder | Deskripsi |
|---|---|
api_gateway/ | Gateway API untuk routing permintaan |
load_balancer/ | Penyeimbang beban untuk distribusi traffic |
Best Practices
- Start with functional grouping - Group by business domain first, then technical layers
- Use numbered sections - Makes navigation easier in large documents
- Maintain table consistency - Same column headers throughout
- Indonesian descriptions - Clear, technical but accessible language
- Note duplicates explicitly - Mark when folders serve similar purposes
- Include purpose statements - Each major section gets a brief explanation
- Cross-reference related components - Link dependent or related folders
Common Pitfalls
- Creating too many nested levels - Keep hierarchy manageable
- Mixing abstraction levels - Don't put low-level and high-level concerns together
- Forgetting intermediate folders - Document the purpose of organizational folders
- Inconsistent naming - Stick to kebab-case or snake_case consistently
- Missing duplicate analysis - Call out when functionality overlaps
- Skipping integration points - Document how components interact