GitScrum / Docs
All Best Practices

Project Wikis | Centralize Team Knowledge

Build project wikis with GitScrum's NoteVault to centralize documentation, knowledge, and processes. Keep institutional knowledge accessible and current.

4 min read

Project wikis centralize institutional knowledge that would otherwise live in scattered documents, Slack threads, and people's heads. GitScrum's NoteVault provides a structured documentation system integrated directly with your project management, keeping documentation close to the work it describes.

Documentation Problems Wikis Solve

ProblemImpactWiki Solution
Knowledge in peoples' headsSingle point of failureWritten documentation
Scattered docsCan't find anythingCentralized location
Outdated informationWrong decisionsReview processes
Onboarding takes weeksSlow productivitySelf-serve guides
Same questions askedTime wasteSearchable FAQ

Wiki Structure Template

PROJECT WIKI ORGANIZATION
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚                                                 β”‚
β”‚  πŸ“ Getting Started                             β”‚
β”‚  β”œβ”€β”€ Project Overview                           β”‚
β”‚  β”œβ”€β”€ Team & Contacts                            β”‚
β”‚  β”œβ”€β”€ Quick Start Guide                          β”‚
β”‚  └── Development Setup                          β”‚
β”‚                                                 β”‚
β”‚  πŸ“ Architecture                                β”‚
β”‚  β”œβ”€β”€ System Overview                            β”‚
β”‚  β”œβ”€β”€ Tech Stack                                 β”‚
β”‚  β”œβ”€β”€ Data Flow                                  β”‚
β”‚  └── Infrastructure                             β”‚
β”‚                                                 β”‚
β”‚  πŸ“ Development                                 β”‚
β”‚  β”œβ”€β”€ Coding Standards                           β”‚
β”‚  β”œβ”€β”€ Git Workflow                               β”‚
β”‚  β”œβ”€β”€ Code Review Process                        β”‚
β”‚  └── Testing Guidelines                         β”‚
β”‚                                                 β”‚
β”‚  πŸ“ Operations                                  β”‚
β”‚  β”œβ”€β”€ Deployment Process                         β”‚
β”‚  β”œβ”€β”€ Environment Config                         β”‚
β”‚  β”œβ”€β”€ Monitoring & Alerts                        β”‚
β”‚  └── Incident Response                          β”‚
β”‚                                                 β”‚
β”‚  πŸ“ Processes                                   β”‚
β”‚  β”œβ”€β”€ Sprint Ceremonies                          β”‚
β”‚  β”œβ”€β”€ Release Process                            β”‚
β”‚  β”œβ”€β”€ On-Call Rotation                           β”‚
β”‚  └── Communication Guide                        β”‚
β”‚                                                 β”‚
β”‚  πŸ“ Decisions                                   β”‚
β”‚  β”œβ”€β”€ ADR-001: Database Choice                   β”‚
β”‚  β”œβ”€β”€ ADR-002: API Architecture                  β”‚
β”‚  └── ADR-003: Auth Strategy                     β”‚
β”‚                                                 β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

Essential Page Templates

ONBOARDING GUIDE TEMPLATE
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚  # New Developer Onboarding                     β”‚
β”‚                                                 β”‚
β”‚  ## Day 1                                       β”‚
β”‚  β–‘ Get access to [systems]                      β”‚
β”‚  β–‘ Clone repositories                           β”‚
β”‚  β–‘ Run local environment                        β”‚
β”‚                                                 β”‚
β”‚  ## Week 1                                      β”‚
β”‚  β–‘ Complete first bug fix                       β”‚
β”‚  β–‘ Review architecture docs                     β”‚
β”‚  β–‘ Meet with team members                       β”‚
β”‚                                                 β”‚
β”‚  ## Month 1                                     β”‚
β”‚  β–‘ Ship first feature                           β”‚
β”‚  β–‘ Participate in on-call                       β”‚
β”‚  β–‘ Contribute to documentation                  β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

RUNBOOK TEMPLATE
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚  # [Service] Runbook                            β”‚
β”‚                                                 β”‚
β”‚  ## Overview                                    β”‚
β”‚  Purpose, dependencies, owners                  β”‚
β”‚                                                 β”‚
β”‚  ## Common Issues                               β”‚
β”‚  | Symptom | Cause | Resolution |               β”‚
β”‚                                                 β”‚
β”‚  ## Deployment                                  β”‚
β”‚  Step-by-step commands                          β”‚
β”‚                                                 β”‚
β”‚  ## Rollback                                    β”‚
β”‚  Emergency rollback procedure                   β”‚
β”‚                                                 β”‚
β”‚  ## Contacts                                    β”‚
β”‚  Escalation path                                β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

DECISION RECORD TEMPLATE
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚  # ADR-XXX: [Title]                             β”‚
β”‚                                                 β”‚
β”‚  **Status:** Proposed/Accepted/Superseded       β”‚
β”‚  **Date:** YYYY-MM-DD                           β”‚
β”‚                                                 β”‚
β”‚  ## Context                                     β”‚
β”‚  What problem are we solving?                   β”‚
β”‚                                                 β”‚
β”‚  ## Decision                                    β”‚
β”‚  What did we decide?                            β”‚
β”‚                                                 β”‚
β”‚  ## Consequences                                β”‚
β”‚  What are the trade-offs?                       β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

Best Practices

  • Start with onboarding docs (highest ROI)
  • Keep structure shallow (max 3 levels deep)
  • Use templates for consistency
  • Assign owners to each section
  • Date all pages with last-updated
  • Link from code to relevant docs
  • Review quarterly for accuracy
  • Make it searchable with good titles
  • Anti-Patterns

    βœ— Creating wiki but never updating
    βœ— Duplicating information in multiple places
    βœ— No ownership = no accountability
    βœ— Deep nested structure nobody can navigate
    βœ— Generic titles that don't describe content
    βœ— Wiki as write-only medium
    

    Related Solutions