3 min read • Guide 346 of 877
What Is NoteVault for Project Documentation?
What is NoteVault for project documentation?
NoteVault is GitScrum's built-in documentation feature that stores project notes with full revision history. Unlike separate wiki tools, NoteVault lives inside your project, ensuring documentation stays connected to actual work. It supports rich text, visibility controls (public/private), and tracks all changes with author attribution [Source: GitScrum Documentation].
NoteVault features
| Feature | Description |
|---|---|
| Rich text editor | Format docs with headers, lists, code blocks |
| Revision history | Track all changes with timestamps |
| Author attribution | See who changed what |
| Visibility controls | Public or private notes |
| Project-linked | Lives inside your project |
| Searchable | Find notes quickly |
What to store in NoteVault:
- Architecture decisions - Record ADRs with reasoning
- Onboarding guides - New developer setup steps
- API documentation - Endpoint specs and examples
- Meeting notes - Sprint planning, retro outcomes
- Deployment procedures - How to release to production
- Technical debt log - Track what needs improvement
- Runbooks - Incident response procedures
- Decision records - Why we chose X over Y
Why integrated documentation works better
| Separate Wiki | NoteVault |
|---|---|
| Different tool, different login | Same tool as tasks |
| Easy to forget to update | Natural to update alongside work |
| Disconnected from context | Linked to project |
| No revision tracking in PM tool | Full history |
| Teams stop using it | Teams actually use it |
| 40% docs become stale in 6 months | Stays current with project |
How to organize NoteVault notes
| Category | Notes |
|---|---|
| Getting Started | Setup guide, access instructions |
| Architecture | System overview, ADRs |
| Processes | Development workflow, review guidelines |
| Technical | API docs, database schema |
| Operations | Runbooks, deployment |
| Meetings | Sprint notes, retros |
NoteVault best practices
- One note per topic - Keep notes focused
- Update during work - Don't wait until later
- Use descriptive titles - Searchable names
- Review quarterly - Check for stale content
- Assign owners - Each doc has a maintainer