documentation

Define documentation standards and templates for Hailo system services.

9|2|Updated Jan 31, 2026

Search Tags:#documentation #standards #service #developer guide #api reference #hailo

Ready to run

npx skills add https://github.com/gregm123456/raspberry_pi_hailo_ai_services --skill documentation-gregm123456

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/gregm123456/raspberry_pi_hailo_ai_services/tree/main/.github/skills/documentation
Command: npx skills add https://github.com/gregm123456/raspberry_pi_hailo_ai_services --skill documentation-gregm123456

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides a clear, standardized framework for documenting system services, ensuring consistency and ease of understanding for developers and users.

Core Features & Use Cases

Documentation Standards: Defines required files (README.md, API_SPEC.md, ARCHITECTURE.md, TROUBLESHOOTING.md) and their content.
Template Examples: Offers practical examples for each documentation file, illustrating best practices.
Use Case: When developing a new AI service for the Hailo platform, use this Skill's guidelines to create comprehensive documentation that adheres to project standards, making the service easier to integrate and maintain.

Quick Start

Follow the documentation standards outlined in this skill for your new service.

Frequently Asked Questions about documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

What files are required for Hailo AI service 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.

How do I write API reference documentation for a new service?▼

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.

What should be included in a developer guide for system services?▼

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.

Does this documentation standard work for any AI service on the Hailo platform?▼

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.

Why do I need an ARCHITECTURE.md file for my service?▼

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.