القائمة
First impressions matter. Set projects up for success.
Create and maintain ASCII visual dashboards for project tracking with parallel lane progress bars
Store and manage voice samples for TTS cloning — portable, version-controlled audio references
Clear documentation through visual excellence
AI music generation via Replicate — 5 models for background tracks, lyrics, and sound design
Practitioner methodology for longitudinal case study research, evidence-based documentation, and publication-ready academic writing in AI-assisted development.
Cloud TTS via Replicate — 15 models, voice cloning, emotion control, and multi-language support
| name | project-scaffolding |
| description | First impressions matter. Set projects up for success. |
| tier | standard |
| applyTo | **/*scaffold*,**/*init*,**/*new*,**/*create*,**/README* |
First impressions matter. Set projects up for success.
| File | Purpose |
|---|---|
README.md | Hero banner + overview + quick start |
CONTRIBUTING.md | How to contribute |
LICENSE.md | Legal terms |
CHANGELOG.md | Version history |
.gitignore | Ignored files |
.editorconfig | Consistent formatting |
<!-- Hero SVG banner -->
# Project Name
> One-line description
## Features
- Feature 1
- Feature 2
## Quick Start
[3 commands max]
## Documentation
[Links]
## License
[Badge + link]
docs/
├── README.md # Index
├── QUICK-START.md # 5-min guide
├── ARCHITECTURE.md # System design
├── API.md # Reference
└── CONTRIBUTING.md # Dev guide
| File | When |
|---|---|
ROADMAP.md | Multi-phase projects |
TODO.md | Simple task tracking |
DECISIONS.md | Architecture decisions |
RISKS.md | Known risks |
| Stack | Essential Configs |
|---|---|
| Node.js | package.json, tsconfig.json, .nvmrc |
| Python | pyproject.toml, requirements.txt |
| VS Code | .vscode/settings.json, launch.json |
| GitHub | .github/workflows/, CODEOWNERS |
| ❌ Don't | ✅ Do | Why |
|---|---|---|
| Empty README | Minimum: name, description, quick start | First impression determines adoption |
| 10+ steps in Quick Start | 3 commands max | Users abandon complex onboarding |
| No license file | Always include LICENSE.md | Legal ambiguity blocks enterprise use |
| Hardcoded paths in docs | Use relative paths, env vars | Breaks for other contributors |
| Stale screenshots | Update visuals with releases | Outdated UI erodes trust |
| Nested folder labyrinths | Max 3 levels deep in docs/ | Deep nesting loses readers |
| Copy-paste from other projects | Customize for your project | Generic docs signal low quality |
Symptom: User follows steps but encounters errors
Causes:
Fix: Add prerequisites section, test on fresh environment, use cross-platform commands
Symptom: Users ask questions already answered in docs
Causes:
Fix: Add TOC in README, use descriptive filenames, cross-link related docs
Symptom: Few contributions despite interest
Causes:
Fix: Start with simple fixes, provide dev container, label beginner issues