Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/CivicActions/project-documentation
Core project documentation artifacts to include in every CivicActions project
https://github.com/CivicActions/project-documentation
Last synced: about 2 months ago
JSON representation
Core project documentation artifacts to include in every CivicActions project
- Host: GitHub
- URL: https://github.com/CivicActions/project-documentation
- Owner: CivicActions
- Created: 2018-08-09T17:46:33.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-08-09T18:22:25.000Z (over 6 years ago)
- Last Synced: 2024-08-01T21:50:23.407Z (5 months ago)
- Size: 1.95 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# [Project Name] Overview
## Description
This is a stub repository to begin to outline minimum project documentation artifacts. The README.md file should provide all participants with core information about where project design / development / documention / code artifacts reside, and should be updated to ensure it contains all the information a new developer, project manager or project owner should need to take control of, and continue development of the project.
### Objectives
To create a core set of documentation artifacts that should be present in EVERY CivicActions project that has code associated with it.
##Staff
**Product owners**
Jane Doe, US Dept of Commerce, [email protected]
**Project managers**
Joe Manager, CivicActions, [email protected]
**Developers**
Sarah Devo, CivicActions, [email protected], backend
James Draw, Civicactions, [email protected], front-end
## Sites and repos
#### Prod
https://testsite.commerce.gov
#### Stage
https://stage.testsite.commerce.gov
#### Dev
https://dev.teststite.commerce.gov
#### Code Repository
[email protected]:bobschmitt-civicactions/project-documentation.git
## Documentation Index
1. [Proposal and contract directory](https://drive.google.com/open?id=0B8h3s4uUHTrZdWJMWlRwTURtN2s)
2. [Sandbox setup](/docs/sandbox.md)
3. [Custom_form module documentation](/example_module/README.md)
## Notes