...
| Expand | ||
|---|---|---|
| ||
No, Confluence should be educational in nature. It should be high-level and not specific. It can outline general steps and information. Should be used as a way to document new technologies, and initiatives, and be general so as to apply to more than one application where possible. |
Example Readme format
| Code Block |
|---|
# APPLICATION NAME
Date Created: 8/14/22
Date Last Modified: 8/14/22
Description:
Tell me what the application does?
Who does it do it for?
How do they benefit?
What makes it special?
Table of Contents:
- [Index item 1](#example1)
- [index item 2](#example2)
...
## Tech stack
- Single page application made in React.js
## Example 1 - Features
## Example 1 - local installation steps
- Do thing 1
- Do thing 2
## Important notes:
> This is a note for new hires
## 🔗 Relevant links
- [link1](https://example.com)
## Runbook
Symptom: "thing happens"
Solution: "Do thing" |
Confluence Format
Fair game! Make it full of pictures, screenshots, gifs. Make it readable. But most importantly, if it could be in a readme because it applies to code, link it one way or the other.GitHub README Template
Confluence guidelines
/rant.