Skip to content

index.md

Latest commit

 

History

History
57 lines (42 loc) · 2.54 KB

index.md

File metadata and controls

57 lines (42 loc) · 2.54 KB
layout default
title Must-Have
nav_order 4
has_children true
permalink /must-have/
doc_mission Define minimum required artifacts that prevent breakage.
doc_out_of_scope Optional maturity practices and tool-format details.

Must-Have Guidelines

These are the non-negotiables. Without them, LLMs will produce code that fundamentally doesn't fit your project — wrong frameworks, wrong file locations, wrong assumptions about what the system does.

Section Responsibility

  • Mission: specify minimum required artifacts that prevent breakage.
  • In scope: must-have artifact content and minimum acceptance criteria.

You don't need all eight in the initial stage. Pick the 3 that matter most for your project and start there. See Incremental Adoption for the ramp-up strategy.

The Eight Must-Haves

# Guideline Prevents
1 Project Scope Model invents features, misunderstands the domain
2 Tech Stack Model suggests wrong languages, libraries, patterns
3 Coding Standards Inconsistent style across generations
4 Testing Strategy Missing tests, wrong test types, untestable code
5 Directory Structure Files in wrong places, broken imports
6 API Contracts Broken interfaces, ignored versioning
7 Security Basics Leaked secrets, bypassed auth, logged PII
8 LLM Guardrails Model modifies protected files, skips verification

How to Read These Pages

Each page follows the same structure:

  • Why This Matters — what goes wrong without this guideline
  • What to Include — specific items to document
  • How to Write It — step-by-step process for your project
  • Example — a short, realistic snippet
  • Common Mistakes — what people get wrong when writing this guideline
  • Tool-Specific Notes — brief notes on per-tool adaptation

Choosing Your First Three

If you're not sure which to start with, use this decision tree:

  • You're building an API or backend: Project Scope + Tech Stack + API Contracts
  • You're building a frontend/fullstack app: Project Scope + Tech Stack + Directory Structure
  • You're working on an established codebase: Coding Standards + Testing Strategy + LLM Guardrails
  • You're in a regulated domain: Project Scope + Security Basics + LLM Guardrails

References