3 min read • Guide 478 of 877
How to Use GitScrum NoteVault for Project Documentation?
How to use GitScrum NoteVault for project documentation?
GitScrum NoteVault provides project-scoped documentation with full revision history. Create docs for ADRs, runbooks, technical decisions, and onboarding guides. All changes are tracked with author and timestamp. Studies show documented projects have 40% faster onboarding and 60% fewer repeated questions [Source: DevOps Research 2024].
Creating documentation in NoteVault:
- Navigate to NoteVault - Access from project menu
- Create new document - Click create button
- Add title and content - Write in markdown
- Organize in folders - Group related docs
- Save document - Auto-saves with revision
- Share with team - Project members can view/edit
Documentation types for NoteVault
| Type | Purpose | Template |
|---|---|---|
| ADR | Architecture decisions | Decision, context, consequences |
| Runbook | Operational procedures | Steps, troubleshooting |
| Setup Guide | Development environment | Prerequisites, steps |
| API Docs | Endpoint documentation | Endpoints, examples |
| Onboarding | New developer guide | First week, resources |
NoteVault features
| Feature | Benefit |
|---|---|
| Revision history | Track all changes |
| Markdown support | Rich formatting |
| Project-scoped | Relevant to project |
| Search | Find content quickly |
| Folders | Organize logically |
| Collaboration | Team editing |
Organizing documentation
| Folder Structure | Contents |
|---|---|
/architecture | ADRs, system design |
/runbooks | Operations, incidents |
/onboarding | New developer guides |
/api | API documentation |
/meetings | Meeting notes |
NoteVault vs external docs
| Aspect | NoteVault | External Wiki |
|---|---|---|
| Project context | ✓ Integrated | Separate |
| Revision history | ✓ Built-in | Varies |
| Access control | Project-based | Configure |
| Discoverability | In project | Search |
| Maintenance | Alongside code | Separate |
Best practices for NoteVault
| Practice | Reason |
|---|---|
| Link to tasks | Connect docs to work |
| Update regularly | Keep current |
| Use templates | Consistency |
| Review periodically | Remove stale docs |
| Assign owners | Accountability |
Documentation workflow
| When | Action |
|---|---|
| New decision | Create ADR in NoteVault |
| Production issue | Document in runbook |
| New team member | Update onboarding |
| API change | Update API docs |
| Sprint planning | Reference docs |