All Chameleon documents to be stored here with the goal of converting all documents to markdown for ease of version control and management.
Updating Existing Documents: Ensure you update the version number and the "last updated" date at the top of any document you edit. Complete rewrites require the version number before the decimal incremented while additions and edits only require the number after the decimal to be incremented. If moving documents, re-link the document to the directory.
Adding New Documents: Ensure you add a version number and a "last updated" date to the top of the document. All documents should be written in markdown .md to help with version control and general document management. Lastly, ensure you insert the document details into the correct position within the directory below.
Pull Request Checklist Before initiating a pull request for a team member to review, ensure you can check off the following.
- Document version updated or added.
- Last updated date reflects the date of changes.
- The document or directory has been added to the Directory List and documents have been linked.
| Directory | Document | Description |
|---|---|---|
| Chameleon Handover Documents | Sub Directory | Templates and Archive of all Handover Documents. |
| Chameleon Policies & Guides | Contains all company policies and guides (NOT for up-skilling docs) | |
| GitHub Repository Use Policy | Best practice for using the Chameleon Git Repo | |
| New Member Onboarding Checklist | Checklist for new members to work through in order to prepare themselves to contribute. | |
| Design Team Documents | Contains all design and branding assets for Chameleon and all Chameleon Projects. | |
| Chameleon Design team - Information Guide | Design Team onboarding information | |
| Company Branding (Sub Directory) | Sub Directory List | |
| User Personas (Sub Directory) | Sub Directory List | |
| How To & Up-Skilling (Sub Directory) | Sub Directory List | |
| Usability Heuristics | Guide for Usability Heuristics | |
| Dark Mode colour for our Figma Design | Dark Mode colour scheme | |
| Colour for our Figma Design | Standard colour scheme | |
| General | Chameleon document Templates, Mission, and other General documents | |
| Company Mission | Chameleon mission statement | |
| Company Structure | Chameleon company structure .png | |
| Project Team Structure | Chameleon project team structure | |
| Templates | Document Templates | |
| Glossary | Chameleon Glossary of Common Terms | |
| AI-DS Glossary | Data Science Glossary of Terms | |
| Chameleon Glossary | Chameleon Glossary of Terms | |
| Up-Skilling & How To | Contains company wide up-skilling recommendations and how to guides. | |
| Markdown Cheat Sheet | How to for Markdown |
