documentation

Required Hailo AI service documentation files include README.md, API_SPEC.md, ARCHITECTURE.md, and TROUBLESHOOTING.md. These files establish a standardized framework ensuring system services are consistently documented and easily understood by developers.

To write API reference documentation for a new service, follow the established documentation standards to create an API_SPEC.md file. This ensures your API reference includes the required content structure, writing style, and examples for Hailo platform integration.

A developer guide for system services should include standardized README.md and TROUBLESHOOTING.md files. These documents provide practical template examples and best practices, facilitating consistent and high-quality documentation across all services.

Yes, this documentation standard works for any AI service on the Hailo platform. It provides a clear, standardized framework encompassing required files and content structure, ensuring consistency and ease of understanding for developers and users across the ecosystem.

You need an ARCHITECTURE.md file to document your service's structural design according to project standards. Establishing this comprehensive documentation standard makes your service easier to integrate and maintain within the Hailo AI ecosystem.