best-practices
Searchable knowledge base of 152+ programming best practices across 30+ languages and frameworks. BM25-powered search over curated resources from industry leaders (Google, Airbnb, Uber, Mozilla, Shopify, OWASP).
Prerequisites
Python 3 must be installed:
python3 --version
How to Use This Workflow
When user asks about coding standards, best practices, style guides, code review, architecture, security, or performance for any language/framework, follow this workflow:
Step 1: Analyze User Requirements
Extract from user request:
- Language/Framework: Python, JavaScript, Go, React, Rails, etc.
- Topic: style guide, design patterns, performance, security, clean code, etc.
- Depth: quick reference vs. deep dive
Step 2: Search Best Practices (REQUIRED)
Always start with --recommend to get comprehensive results (resources + deep content):
python3 .kiro/steering/best-practices/scripts/search.py "<language> <topic>" --recommend
Examples:
python3 .kiro/steering/best-practices/scripts/search.py "python style guide" --recommend
python3 .kiro/steering/best-practices/scripts/search.py "javascript clean code" --recommend
python3 .kiro/steering/best-practices/scripts/search.py "react performance" --recommend
python3 .kiro/steering/best-practices/scripts/search.py "sql optimization" --recommend
python3 .kiro/steering/best-practices/scripts/search.py "api security" --recommend
Step 3: Supplement with Domain Searches (as needed)
# Search all resources (default)
python3 .kiro/steering/best-practices/scripts/search.py "<query>" --domain resource
# Search by language/technology overview
python3 .kiro/steering/best-practices/scripts/search.py "<query>" --domain language
# Search by category
python3 .kiro/steering/best-practices/scripts/search.py "<query>" --domain category
# Deep search within crawled content files
python3 .kiro/steering/best-practices/scripts/search.py "<query>" --content
# Deep search filtered by language
python3 .kiro/steering/best-practices/scripts/search.py "<query>" --content --lang python
Step 4: Read Deep Content (when needed)
When a search result includes a File path, read it for detailed content:
content/core_technologies/250af6826bbd.md → Google JavaScript Style Guide
content/web_backend/b8aad3894efa.md → Python Code Style Guide
Search Reference
Available Domains
| Domain |
Use For |
Example |
resource |
All 152+ resources with metadata |
"python best practices" |
language |
Language/tech overview with top resources |
"go", "react" |
category |
Browse by category |
"frontend", "security" |
Content Search (--content)
Searches within the actual crawled markdown files for deeper matches. Use --lang to filter by language.
Authority Levels
Results are tagged with authority:
- ⭐
industry-leader — Google, Airbnb, Uber, Mozilla, Microsoft, Shopify
- 🏆
standard — OWASP, 12factor, Refactoring.Guru
open-source — GitHub community projectscommunity — Blog posts, tutorials
Coverage
Languages & Frameworks (30+)
| Domain |
Technologies |
| Backend |
Python, Ruby, Rails, PHP, Laravel, Node.js, NestJS, Go, Java, Kotlin, Scala, C#, Elixir |
| Frontend |
JavaScript, TypeScript, HTML, CSS, SASS, React, Vue, Angular, Next.js, Nuxt |
| Systems |
C, C++, Rust |
| Mobile |
Swift, Objective-C, Flutter, Dart, React Native |
| Database |
SQL, PostgreSQL, MySQL, NoSQL/MongoDB |
| DevOps |
Bash, AWS, Microservices, Docker |
| Security |
OWASP, API Security, DevSecOps |
| AI/ML |
MLOps, LLM, Responsible AI |
Featured Resources (Must-Know)
| Topic |
Resource |
Authority |
| JavaScript Style |
Airbnb Style Guide |
⭐ industry-leader |
| Clean Code |
Clean Code JavaScript |
open-source |
| System Design |
System Design 101 (ByteByteGo) |
open-source |
| Cloud Native |
The Twelve-Factor App |
🏆 standard |
| Security |
OWASP Top 10 |
🏆 standard |
| Go Style |
Uber Go Style Guide |
⭐ industry-leader |
| Ruby Style |
Community Ruby Style Guide |
open-source |
| Design Patterns |
Refactoring.Guru |
🏆 standard |
Common Query Mapping
| User Asks About |
Search Query |
| Code style for [language] |
"<language> style guide" --recommend |
| How to structure a project |
"system design architecture" --recommend |
| Security best practices |
"security owasp api" --recommend |
| Database optimization |
"sql postgresql optimization" --recommend |
| Frontend performance |
"frontend performance web vitals" --recommend |
| Code review checklist |
"code review best practices" --recommend |
| Cloud deployment |
"aws microservices cloud native" --recommend |
| Design patterns for [lang] |
"<language> design patterns" --recommend |
Rebuilding the CSV Database
If new content is crawled, regenerate the CSVs:
python3 .kiro/steering/best-practices/scripts/generate_csv.py
This reads content/index.json and produces:
data/resources.csv — All 152+ resources with metadatadata/languages.csv — Aggregated by language/technologydata/categories.csv — Aggregated by category
Source: dereknguyen269/programing-best-practices — distributed by TomeVault.
1---2name: programing-best-practices3description: Searchable knowledge base of 152+ programming best practices across 30+ languages and frameworks. BM25-powered search over curated resources from industry leaders (Google, Airbnb, Uber, Mozilla, Shopify, OWASP). Use when this capability is needed.4---56# best-practices78Searchable knowledge base of 152+ programming best practices across 30+ languages and frameworks. BM25-powered search over curated resources from industry leaders (Google, Airbnb, Uber, Mozilla, Shopify, OWASP).910## Prerequisites1112Python 3 must be installed:1314```bash15python3 --version16```1718## How to Use This Workflow1920When user asks about coding standards, best practices, style guides, code review, architecture, security, or performance for any language/framework, follow this workflow:2122### Step 1: Analyze User Requirements2324Extract from user request:25- **Language/Framework**: Python, JavaScript, Go, React, Rails, etc.26- **Topic**: style guide, design patterns, performance, security, clean code, etc.27- **Depth**: quick reference vs. deep dive2829### Step 2: Search Best Practices (REQUIRED)3031**Always start with `--recommend`** to get comprehensive results (resources + deep content):3233```bash34python3 .kiro/steering/best-practices/scripts/search.py "<language> <topic>" --recommend35```3637**Examples:**38```bash39python3 .kiro/steering/best-practices/scripts/search.py "python style guide" --recommend40python3 .kiro/steering/best-practices/scripts/search.py "javascript clean code" --recommend41python3 .kiro/steering/best-practices/scripts/search.py "react performance" --recommend42python3 .kiro/steering/best-practices/scripts/search.py "sql optimization" --recommend43python3 .kiro/steering/best-practices/scripts/search.py "api security" --recommend44```4546### Step 3: Supplement with Domain Searches (as needed)4748```bash49# Search all resources (default)50python3 .kiro/steering/best-practices/scripts/search.py "<query>" --domain resource5152# Search by language/technology overview53python3 .kiro/steering/best-practices/scripts/search.py "<query>" --domain language5455# Search by category56python3 .kiro/steering/best-practices/scripts/search.py "<query>" --domain category5758# Deep search within crawled content files59python3 .kiro/steering/best-practices/scripts/search.py "<query>" --content6061# Deep search filtered by language62python3 .kiro/steering/best-practices/scripts/search.py "<query>" --content --lang python63```6465### Step 4: Read Deep Content (when needed)6667When a search result includes a `File` path, read it for detailed content:6869```70content/core_technologies/250af6826bbd.md → Google JavaScript Style Guide71content/web_backend/b8aad3894efa.md → Python Code Style Guide72```7374---7576## Search Reference7778### Available Domains7980| Domain | Use For | Example |81|--------|---------|---------|82| `resource` | All 152+ resources with metadata | `"python best practices"` |83| `language` | Language/tech overview with top resources | `"go"`, `"react"` |84| `category` | Browse by category | `"frontend"`, `"security"` |8586### Content Search (--content)8788Searches within the actual crawled markdown files for deeper matches. Use `--lang` to filter by language.8990### Authority Levels9192Results are tagged with authority:93- ⭐ `industry-leader` — Google, Airbnb, Uber, Mozilla, Microsoft, Shopify94- 🏆 `standard` — OWASP, 12factor, Refactoring.Guru95- `open-source` — GitHub community projects96- `community` — Blog posts, tutorials9798---99100## Coverage101102### Languages & Frameworks (30+)103104| Domain | Technologies |105|--------|-------------|106| Backend | Python, Ruby, Rails, PHP, Laravel, Node.js, NestJS, Go, Java, Kotlin, Scala, C#, Elixir |107| Frontend | JavaScript, TypeScript, HTML, CSS, SASS, React, Vue, Angular, Next.js, Nuxt |108| Systems | C, C++, Rust |109| Mobile | Swift, Objective-C, Flutter, Dart, React Native |110| Database | SQL, PostgreSQL, MySQL, NoSQL/MongoDB |111| DevOps | Bash, AWS, Microservices, Docker |112| Security | OWASP, API Security, DevSecOps |113| AI/ML | MLOps, LLM, Responsible AI |114115### Featured Resources (Must-Know)116117| Topic | Resource | Authority |118|-------|----------|-----------|119| JavaScript Style | Airbnb Style Guide | ⭐ industry-leader |120| Clean Code | Clean Code JavaScript | open-source |121| System Design | System Design 101 (ByteByteGo) | open-source |122| Cloud Native | The Twelve-Factor App | 🏆 standard |123| Security | OWASP Top 10 | 🏆 standard |124| Go Style | Uber Go Style Guide | ⭐ industry-leader |125| Ruby Style | Community Ruby Style Guide | open-source |126| Design Patterns | Refactoring.Guru | 🏆 standard |127128---129130## Common Query Mapping131132| User Asks About | Search Query |133|-----------------|-------------|134| Code style for [language] | `"<language> style guide" --recommend` |135| How to structure a project | `"system design architecture" --recommend` |136| Security best practices | `"security owasp api" --recommend` |137| Database optimization | `"sql postgresql optimization" --recommend` |138| Frontend performance | `"frontend performance web vitals" --recommend` |139| Code review checklist | `"code review best practices" --recommend` |140| Cloud deployment | `"aws microservices cloud native" --recommend` |141| Design patterns for [lang] | `"<language> design patterns" --recommend` |142143---144145## Rebuilding the CSV Database146147If new content is crawled, regenerate the CSVs:148149```bash150python3 .kiro/steering/best-practices/scripts/generate_csv.py151```152153This reads `content/index.json` and produces:154- `data/resources.csv` — All 152+ resources with metadata155- `data/languages.csv` — Aggregated by language/technology156- `data/categories.csv` — Aggregated by category157158---159> Source: [dereknguyen269/programing-best-practices](https://github.com/dereknguyen269/programing-best-practices) — distributed by [TomeVault](https://tomevault.io).160<!-- tomevault:4.0:skill_md:2026-06-25 -->
tomevault-io