Inhaltsverzeichnis
Project Documentation Checklist
Version: 2.0
Scope: Content expectations for README.md / PROJECT.md / SKILL.md.
README.md (End Users)
- [ ] One-sentence product description
- [ ] Installation instructions (Windows/Linux)
- [ ] Configuration options with defaults
- [ ] Simple usage examples
- [ ] Troubleshooting section
- [ ] Help/support links
PROJECT.md (Developers)
- [ ] References WvdS Best Practices at top
- [ ] Clear „what“ and „why“ explanation
- [ ] Navigation to sub-documents (if split)
- [ ] Build instructions that work from scratch
- [ ] All dependencies with versions listed
- [ ] License and copyright
SKILL.md (AI Assistants)
- [ ] YAML frontmatter with name/description
- [ ] Under 300 lines (main file)
- [ ] Navigation to sub-documents
- [ ] Naming conventions
- [ ] Build commands
- [ ] Quick reference section
- [ ] AI should be able to rebuild all packages from scratch
Version: 2.0 (Split)
Author: Wolfgang van der Stille
Back to Project Checklists | Review Checklists
Zuletzt geändert: on 2026/01/08 at 01:50 AM