Readme guidelines
Things to remember when picking up cards to improvise readme
- Add the below sections (wherever applicable):
- Intro/Overview/Definition
- Use case
- Example (professional and generic without revealing any client data):
- How to configure
- How it will display in mobile app
- Nuances/Different options available
- Dos and don'ts
- Add relevant GIFs/images/videos
- When adding readme for 'End users/analysts' make sure not to use technical phrases or define them where needed
Updated 3 months ago