Skip to content

README.md

Latest commit

 

History

History
159 lines (109 loc) · 4.94 KB

README.md

File metadata and controls

159 lines (109 loc) · 4.94 KB

CivicTechWR Project Wiki Template

This directory contains template files for setting up a comprehensive GitHub Wiki for your CivicTechWR project.

Using This Template

1. Enable Wiki for Your Repository

  1. Go to your GitHub repository settings
  2. Scroll down to "Features" section
  3. Check "Wikis" to enable the wiki feature

2. Set Up Wiki Pages

Copy the content from these template files to create corresponding pages in your GitHub wiki:

Template File Wiki Page Name Purpose
Home.md Home Main wiki landing page
Project-Overview.md Project-Overview Comprehensive project description
Team-and-Roles.md Team-and-Roles Team member information
Community-Partners.md Community-Partners Stakeholder relationships
Season-Timeline.md Season-Timeline 12-week project schedule
User-Research.md User-Research Community research findings
Technical-Architecture.md Technical-Architecture System design details
Meeting-Notes.md Meeting-Notes Weekly meeting documentation
Decision-Log.md Decision-Log Important project decisions

3. Customize for Your Project

  1. Replace all placeholder content (marked with [brackets])
  2. Update navigation links to match your project structure
  3. Add project-specific sections as needed

4. Maintain Throughout Season

  • Update project status regularly
  • Document key decisions and changes
  • Keep team and partner information current
  • Record meeting notes and progress updates

Wiki Structure Benefits

For Team Collaboration

  • ✅ Central hub for all project information
  • ✅ Clear team roles and responsibilities
  • ✅ Decision tracking and rationale
  • ✅ Meeting notes and action items

For Community Engagement

  • ✅ Transparent project progress
  • ✅ Clear ways for community to get involved
  • ✅ Impact measurement and reporting
  • ✅ Accessible documentation for all skill levels

For CTWR Integration

  • ✅ Season timeline and milestone management
  • ✅ Community partnership documentation
  • ✅ Demo Day preparation resources

For Long-term Sustainability

  • ✅ Knowledge preservation for future contributors
  • ✅ Handoff documentation for post-season
  • ✅ Community impact story for funding/partnerships
  • ✅ Technical documentation for maintenance

Wiki Best Practices

Content Guidelines

  • Write for multiple audiences (technical and non-technical)
  • Keep information current and accurate
  • Use clear, accessible language
  • Include visuals when helpful (screenshots, diagrams)

Organization Tips

  • Use consistent navigation across pages
  • Link related pages together
  • Create clear hierarchies and categories
  • Make important information easy to find

Maintenance Schedule

  • Weekly: Update meeting notes and progress
  • Bi-weekly: Review and update team/role information
  • Monthly: Update impact metrics
  • Season milestones: Major updates to overview and timeline

Additional Wiki Pages (Optional)

Based on your project needs, consider adding:

Technical Documentation

  • API-Documentation.md - Technical integration details
  • Development-Setup.md - How to contribute code
  • Testing-Strategy.md - QA and accessibility testing
  • Deployment-Guide.md - How system is deployed

Community Resources

  • User-Guides.md - How community members use the system
  • Accessibility-Guide.md - Ensuring inclusive design
  • FAQ.md - Common questions and answers
  • Feedback-and-Support.md - How to get help or provide input

Project Management

  • Issue-Tracking.md - GitHub project integration
  • Demo-Day-Preparation.md - Presentation planning
  • Risk-Management.md - Project risks and mitigation
  • Resource-Planning.md - Budget and resource allocation

Integration with Other CTWR Tools

GitHub Projects

  • Link wiki pages to project issues and milestones
  • Reference wiki documentation in issue templates

Documentation Repository

  • Link to main CTWR documentation for guidelines
  • Reference community policies and procedures
  • Connect to organization-wide resources

Community Platforms

  • Share wiki links in community discussions
  • Use wiki for Demo Day presentation preparation
  • Reference in partner communications

Getting Help

CTWR Community Support

  • Ask in weekly community meetings
  • Use community Slack/Discord for wiki questions
  • Reference main CTWR documentation repository

GitHub Wiki Resources

📚 Template Information:

  • Created for: CivicTechWR Project Template
  • Compatible with: GitHub Wikis
  • Framework: Civic tech workflow with 12-week lifecycle
  • Maintenance: Update placeholders and customize for your project