About Pepe Docs
It is the handbook for the product and engineering team at Jobbatical!
What to write here
- Team member onboarding
- How a product feature works
- Roles and Permissions
- Engineering processes and workflows
- Engineering best practices
- Style guides for the codebase
- How-to's for engineering work
- General architecture details
Where to write code documentation?
Always add code-specific details inside the code as comments. While reviewing PR, ask for more comments if you didn't understand the flow easily.
Where to write docs about running a project?
Readme.md files are specifically for this use case. So keep those details closer to the codebase.