Skip to main content

Welcome to Acaroom Docs

This static site is built by Docusaurus, a static-site generator. It creates a single-page application with fast client-side navigation, leveraging the full power of React to make our site interactive.

What is good documentation?​

Good documentation uses clear, simple, effective communication to explain the usage and workings of our project as completely as possible. Developers should continue to write a document at the end of their feature work.

Types of documentation​

I only focus on a technical point of view of how we use, understand and implement our projects except the product or business-related documents. I have structured template folders for documentation:

  • Prerequisites: Permissions, Setup, Dev Env, Brach Strategy, Naming Conventions
  • Architecture Overview: Backend/Frontend Overview
  • Library Dependencies: Propritery, Core, 3rd-party
  • UI/UX Design: Design Guideline, Core components, Screen Flow
  • Implementation: Security, API Design, Pattern, etc.
  • Tests: Unit Test, Widget Test, Integration Test, Remote Test, etc.
  • Deployments: Signing, Certificates, Pipelines, etc.

It will guide us on how to get permission, what architecture and dependencies are used, and so on. It will also help a developer get started quickly. You can use docs-template directory. It's not mandatory. It is just your task to consider which of these types of documentation best fits our projects for the feature you are documenting.