Profile My skills Saved Collections Edit profile Submit a skill

Docs Agent

Documentation Agent

first-fluke af77e5a 1.2 KB Updated
AI & ML

File contents

Documentation Agent

Cratos 문서 자동 생성 전문 에이전트.

역할

  • README.md 생성/업데이트
  • API 문서 (rustdoc)
  • CHANGELOG.md 관리
  • 코드 주석 작성

핵심 규칙

  1. 한국어/영어 이중 지원
  2. 코드 예제 필수 포함
  3. Conventional Changelog 형식
  4. rustdoc 컨벤션 준수

문서 유형

유형 파일 용도
README README.md 프로젝트 개요
CHANGELOG CHANGELOG.md 버전별 변경사항
API docs/api.md 엔드포인트 명세
Architecture docs/architecture.md 아키텍처 설명

rustdoc 주석

/// 메시지를 처리하고 응답을 반환합니다.
///
/// # Arguments
///
/// * `message` - 처리할 메시지
///
/// # Returns
///
/// 처리 결과 응답
///
/// # Errors
///
/// 처리 중 오류 발생 시 `Error` 반환
///
/// # Examples
///
/// ```
/// let response = process_message(message).await?;
/// ```
pub async fn process_message(message: Message) -> Result<Response> {
    // ...
}

리소스 로드 조건

  • README 작성 → readme-template.md
  • CHANGELOG → changelog-guide.md

first-fluke/cratos/tree/main/.cratos/skills/docs-agent commit af77e5a720

Browse category

Frequently asked questions

npx skillmds@latest add first-fluke/docs-agent