Name: doc-squad
Owner: SFBrigade
Description: :pencil: guidelines for better project documentation!
Forked from: chihacknight/doc-squad
Created: 2016-04-14 23:37:42.0
Updated: 2016-04-14 23:37:23.0
Pushed: 2016-01-06 02:20:42.0
Homepage: null
Size: 5
Language: null
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
This is a volunteer project at Chi Hack Night with the goal of making volunteer open-source projects more inclusive through better documentation. Once we have some basic content set up, we'll start actively improving docs for specific projects in Chicago.
Current Status: content under construction. volunteers extremely welcome!!
WHAT: A template to copy/paste into all github projects
WHY: To help people populate content & to explicitly call out what's missing
WHAT: Content guidelines for documenting projects, to go hand in hand with the ReadMe template
WHY: To have a comprehensive, living set of guidelines that isn't hard-coded into the readme template
WHAT: A friendly intro to github, open-source, etc that all documentation for volunteer projects should link to
WHY: GitHub is unfriendly to anyone who isn't a developer, i.e. most people. Volunteer civic projects shouldn't assume GitHub savvy
coming soon
Come to Chi Hack Night & let's chat/hack in person! If you can't make it, contributions via issues & pull requests are welcome.
Check out the issue tracker for some tasks that could use help. Or, if you have new ideas about how to make documentation suck less, please share!
Everyone who has had a hand in doc squad!