|
| 1 | +--- |
| 2 | +status: in-progress |
| 3 | +created: '2025-11-26' |
| 4 | +tags: |
| 5 | + - onboarding |
| 6 | + - user-experience |
| 7 | + - agents-md |
| 8 | +priority: high |
| 9 | +created_at: '2025-11-26T08:24:50.022Z' |
| 10 | +updated_at: '2025-11-26T08:24:54.329Z' |
| 11 | +transitions: |
| 12 | + - status: in-progress |
| 13 | + at: '2025-11-26T08:24:54.329Z' |
| 14 | +--- |
| 15 | + |
| 16 | +# Streamline Onboarding: Clear Project Context Section |
| 17 | + |
| 18 | +> **Status**: ⏳ In progress · **Priority**: High · **Created**: 2025-11-26 · **Tags**: onboarding, user-experience, agents-md |
| 19 | +
|
| 20 | +**Project**: lean-spec |
| 21 | +**Team**: Core Development |
| 22 | + |
| 23 | +## Overview |
| 24 | + |
| 25 | +User feedback indicates confusion about where to add project information (description, objectives, tech stack) during onboarding. The current AGENTS.md has a generic placeholder that users don't realize needs customization. |
| 26 | + |
| 27 | +**Problem**: Current AGENTS.md header says: |
| 28 | +``` |
| 29 | +## Project: {project_name} |
| 30 | +Lightweight spec methodology for AI-powered development. |
| 31 | +``` |
| 32 | +Users don't realize this is a placeholder they should replace with their actual project description. |
| 33 | + |
| 34 | +**Solution**: |
| 35 | +1. Add an explicit "Project Context" section with clear TODO markers |
| 36 | +2. Include prompts for what to add (description, tech stack, objectives) |
| 37 | +3. Improve "Next steps" messaging to specifically call out this section |
| 38 | + |
| 39 | +## Design |
| 40 | + |
| 41 | +### AGENTS.md Changes |
| 42 | + |
| 43 | +Add a new "📋 Project Context" section after the project header with clear TODO markers: |
| 44 | + |
| 45 | +```markdown |
| 46 | +## Project: {project_name} |
| 47 | + |
| 48 | +<!-- 👇 TODO: Replace this section with your project info --> |
| 49 | +### 📋 Project Context (Edit This!) |
| 50 | + |
| 51 | +**What this project does:** |
| 52 | +<!-- Describe your project in 1-2 sentences --> |
| 53 | +_Example: A task management API for team collaboration_ |
| 54 | + |
| 55 | +**Tech stack:** |
| 56 | +<!-- List main technologies --> |
| 57 | +_Example: Node.js, Express, PostgreSQL, Redis_ |
| 58 | + |
| 59 | +**Key objectives:** |
| 60 | +<!-- What are you building toward? --> |
| 61 | +_Example: Launch MVP with core CRUD operations by Q1_ |
| 62 | +<!-- 👆 End of TODO section --> |
| 63 | +``` |
| 64 | + |
| 65 | +### Init "Next steps" Update |
| 66 | + |
| 67 | +Change from vague "Review and customize AGENTS.md" to specific: |
| 68 | +``` |
| 69 | +Next steps: |
| 70 | + 1. Edit AGENTS.md → Fill in "Project Context" section with your project info |
| 71 | + 2. Create your first spec: lean-spec create my-feature |
| 72 | +``` |
| 73 | + |
| 74 | +## Plan |
| 75 | + |
| 76 | +- [x] Update standard template AGENTS.md with Project Context section |
| 77 | +- [x] Update detailed template AGENTS.md with Project Context section |
| 78 | +- [x] Update init.ts "Next steps" messaging |
| 79 | +- [ ] Test init flow end-to-end |
| 80 | + |
| 81 | +## Notes |
| 82 | + |
| 83 | +### User Feedback |
| 84 | +User didn't know where to add project info (what the project is about, objectives). The AGENTS.md file looked "complete" and they didn't realize customization was needed. |
0 commit comments