33 lines
910 B
Markdown
33 lines
910 B
Markdown
|
# Documentation
|
||
|
|
|
||
|
|
Documentation has a few different scopes that everyone should be aware of. Internal documentation is documentation that
|
||
|
|
focuses on things relevant to employees of the company.
|
||
|
|
|
||
|
|
## Internal
|
||
|
|
|
||
|
|
> :bangbang: **This documentation is private to the company.**
|
||
|
|
|
||
|
|
Internal documentation doesn't need to be as fancy as it's public facing counter-part.
|
||
|
|
|
||
|
|
- [Architecture](internal/ARCHITECTURE.md)
|
||
|
|
- [Developers Guide](internal/DEVELOPING.md)
|
||
|
|
|
||
|
|
### Decisions
|
||
|
|
|
||
|
|
- [Template](internal/decisions/_template.md)
|
||
|
|
- [Initial Technology Selection](internal/decisions/initial-technology-selection.md)
|
||
|
|
|
||
|
|
### Designs
|
||
|
|
|
||
|
|
- [Template](internal/designs/_template.md)
|
||
|
|
|
||
|
|
### Runbooks
|
||
|
|
|
||
|
|
- [Runbook Template](internal/runbooks/_template.md)
|
||
|
|
|
||
|
|
## Public
|
||
|
|
|
||
|
|
> :bangbang: **This documentation is public, and accessible to end-users.**
|
||
|
|
|
||
|
|
Most projects implement [public](public) documentation using solutions like Jekyll, Hugo, and Astro.
|