Skip to content

Wiki Maintenance Plan

Jump to bottom
iDorgham edited this page Nov 23, 2025 · 1 revision

Wiki Maintenance Plan

Complete maintenance plan and update procedures for the DoPlan CLI GitHub Wiki.

Regular Update Schedule

Quarterly Reviews

Frequency: Every 3 months

Tasks:

  • Review all pages for accuracy
  • Update outdated information
  • Check and fix broken links
  • Update examples and code snippets
  • Review user feedback

Schedule:

  • Q1: January
  • Q2: April
  • Q3: July
  • Q4: October

Monthly Checks

Frequency: Every month

Tasks:

  • Quick link check
  • Review recent changes
  • Update version numbers
  • Check for new features to document

As-Needed Updates

Triggers:

  • New feature releases
  • Breaking changes
  • User-reported issues
  • Community feedback

Response Time: Within 1 week

Review Checklist

Content Review

  • All pages reviewed for accuracy
  • Technical information verified
  • Code examples tested
  • Screenshots updated (if applicable)
  • Version numbers current
  • Feature descriptions accurate

Link Review

  • All internal links working
  • All external links verified
  • GitHub links current
  • Documentation links valid
  • No broken references

Formatting Review

  • Consistent formatting across pages
  • Proper heading hierarchy
  • Code blocks formatted correctly
  • Tables properly formatted
  • Lists consistent

Style Review

  • Consistent writing style
  • Grammar and spelling checked
  • Professional tone maintained
  • Clear and concise language

Update Procedures

Adding New Pages

  1. Create Page:

    • Create new markdown file in wiki/ directory
    • Follow existing page templates
    • Use consistent formatting

  2. Update Navigation:

    • Add link to Home page
    • Update related pages
    • Add to appropriate sections

  3. Review:

    • Self-review for accuracy
    • Check formatting
    • Verify links

  4. Publish:

    • Commit to repository
    • Push to GitHub
    • Update GitHub wiki

Updating Existing Pages

  1. Identify Updates Needed:

    • Review content
    • Check for outdated information
    • Identify improvements

  2. Make Updates:

    • Edit markdown file
    • Update content
    • Fix formatting if needed

  3. Review Changes:

    • Verify accuracy
    • Check formatting
    • Test links

  4. Publish:

    • Commit changes
    • Push to GitHub
    • Update GitHub wiki

Removing Pages

  1. Identify Deprecated Pages:

    • Check if content is outdated
    • Verify if replacement exists
    • Confirm removal is appropriate

  2. Remove:

    • Delete markdown file
    • Remove from navigation
    • Update related pages

  3. Document:

    • Note removal in changelog
    • Update related documentation

Link Checking Process

Automated Checking

Tools:

  • GitHub Actions workflow (if implemented)
  • Link checking scripts
  • Manual verification

Frequency: Monthly

Manual Checking

Process:

  1. Review each page
  2. Check all links
  3. Verify external links
  4. Fix broken links
  5. Update outdated links

Checklist:

  • Internal wiki links
  • External documentation links
  • GitHub repository links
  • Release links
  • Example repository links

Link Maintenance

Broken Links:

  1. Identify broken link
  2. Find replacement or remove
  3. Update page
  4. Verify fix

Outdated Links:

  1. Identify outdated link
  2. Find current version
  3. Update link
  4. Verify accuracy

Version Control Sync

Repository Structure

Wiki pages are maintained in:

  • wiki/ directory in main repository
  • GitHub wiki (for published version)

Sync Process

  1. Development:

    • Edit files in wiki/ directory
    • Commit to repository
    • Push to GitHub

  2. Publication:

    • Copy files to GitHub wiki
    • Verify formatting
    • Test links

  3. Version Control:

    • All changes tracked in git
    • Commit messages descriptive
    • Regular commits

Maintenance Responsibilities

Documentation Lead

Responsibilities:

  • Overall wiki maintenance
  • Quarterly reviews
  • Content quality
  • Update coordination

Documentation Writer

Responsibilities:

  • Content updates
  • Link checking
  • Formatting consistency
  • User feedback response

Community Contributors

Responsibilities:

  • Report issues
  • Suggest improvements
  • Submit updates via PRs
  • Provide feedback

Update Templates

New Page Template

# Page Title

Brief description of what this page covers.

## Overview

[Overview section]

## Section 1

[Content]

## Section 2

[Content]

## Related Pages

- [Link to related page 1](Related-Page-1)
- [Link to related page 2](Related-Page-2)

## See Also

- [Main Documentation](Home)
- [Quick Start](Quick-Start)

---

**Last Updated**: YYYY-MM-DD  
**Maintained By**: Documentation Team

Update Log Template

## Update Log

### YYYY-MM-DD
- Updated [page name] with [changes]
- Fixed broken link to [link]
- Added [new content]

### YYYY-MM-DD
- Quarterly review completed
- Updated all version numbers
- Reviewed all links

Quality Assurance

Pre-Publication Checklist

  • Content reviewed
  • Links verified
  • Formatting checked
  • Grammar and spelling checked
  • Examples tested
  • Navigation updated

Post-Publication Review

  • Pages accessible
  • Navigation working
  • Links functional
  • Formatting correct
  • User feedback collected

Related Pages

Last Updated: 2025
Maintained By: Documentation Team

Clone this wiki locally