{
 "schema_version": 1,
 "generated": "2026-10-20",
 "id": "xop01-ai-goodpractice--write-feature-docs-so-ai-finds-code-without-full-reads",
 "repo": "xop01/ai_goodpractice",
 "repo_url": "https://github.com/xop01/ai_goodpractice",
 "repo_slug": "xop01-ai-goodpractice",
 "title": "Write feature docs so AI finds code without full reads",
 "page_title": "How to write feature docs so AI finds code without full reads with AI Goodpractice",
 "summary": "Keep short docs for each important feature so the AI can locate code and behavior quickly.",
 "who": "A developer on a growing project who wants the AI to understand parts of the code without re-reading every file each time.",
 "problem": "Without docs, the AI has to read files in their entirety to learn which code does what.",
 "outcome": "Feature documents the AI can read first to find related code, expected behavior and open follow-ups.",
 "steps": [
  "Pick one important feature or infrastructure part of your project.",
  "Write a short doc yourself, or ask the AI to write it, covering what the part does and how it behaves.",
  "Ask the AI to record bugs and their fixes in docs, including follow-ups that are not done yet.",
  "Tell the AI to read the relevant doc before opening source files.",
  "Review the docs regularly and check whether any open follow-up has become easier to solve."
 ],
 "agent_prompt": "In <project path>, write a documentation file for the <feature name> part that explains what it does, how it behaves and which files relate to it. Expected output: one doc file in the project's docs area. Verify that the doc ends with a list of any open follow-up items.",
 "agents": [
  "cursor",
  "claude-code"
 ],
 "difficulty": "Beginner",
 "time": "30 minutes",
 "basis": "readme",
 "caveat": "The guide gives no fixed doc format, so choose a structure you will keep up to date.",
 "category": "Software and DevOps",
 "tags": [
  "Software and DevOps"
 ],
 "lang": "",
 "requirements": [
  "An AI-enabled IDE such as Cursor, VS Code, or Claude Code",
  "A project folder or repo to apply the setup to",
  "Access to an AI model; the guide's author uses a mix of Claude, ChatGPT and Grok through Cursor"
 ],
 "risk": "none",
 "seen_in_the_wild": false,
 "mentioned_publicly": false,
 "risks": [],
 "best": false,
 "score": 0.8,
 "evidence": [],
 "url": "https://dedupedai.com/use-cases/xop01-ai-goodpractice/write-feature-docs-so-ai-finds-code-without-full-reads/",
 "md": "https://dedupedai.com/use-cases/xop01-ai-goodpractice/write-feature-docs-so-ai-finds-code-without-full-reads/index.md",
 "disclaimer": "Deduped lists open-source repositories that belong to other people. We do not own, maintain, audit, or vouch for any of them, and a repo appearing here is not an endorsement or a safety check. The use cases, steps, and prompts are written by AI and may be incomplete, outdated, or just wrong. Where a use case is marked \"Seen in the wild\", we link to public posts where someone described something similar, but we have not verified those posts and the use case itself is still our AI's own write-up. Use all of this at your own risk. Only run code, commands, or agents on systems and accounts you are authorized to use, and read the code and every command before you run it, especially anything that touches credentials, files, or the network. Nothing here is professional, security, legal, or financial advice. All trademarks and project names belong to their respective owners, and their use here does not imply affiliation. Content is provided as is, without warranties of any kind. Found a mistake, a safety problem, or something you want removed? Email hello@dedupedai.com and we will look at it promptly.",
 "api": "https://dedupedai.com/api/v1/usecases/xop01-ai-goodpractice--write-feature-docs-so-ai-finds-code-without-full-reads.json",
 "api_version": "v1"
}