SDK API Documenter
Development community intermediate
Description
Ensure the babysitter SDK has complete, accurate documentation for all public interfaces.
Installation
Terminal
claude install-skill https://github.com/a5c-ai/babysitter README
name: sdk-api-documenter description: Generate and validate documentation for @a5c-ai/babysitter-sdk CLI commands and exported APIs
SDK API Documenter
Ensure the babysitter SDK has complete, accurate documentation for all public interfaces.
Scope
CLI Commands
Location: `packages/sdk/src/cli/`
Document each command:
- undefined
Exported APIs
Location: `packages/sdk/src/` (check `index.ts` for exports)
Document each export:
- undefined
Documentation Workflow
1. Discover Public Interfaces
# Find CLI commands
grep -r "command\|program\." packages/sdk/src/cli/ --include="*.ts" | head -30
# Find exports
cat packages/sdk/src/index.ts
# Find types
ls packages/sdk/src/types/
2. Check Existing Documentation
# README
cat packages/sdk/README.md 2>/dev/null || echo "No README"
# JSDoc in source
grep -r "@param\|@returns\|@example" packages/sdk/src/ --include="*.ts" | head -20
3. Generate Documentation
For each public interface, ensure:
CLI Commands
### `babysitter `
**Description**: What the command does
**Usage**:
```bash
babysitter [options]
**Arguments**:
| Argument | Type | Required | Description |
|---|---|---|---|
arg |
string | Yes | Description |
**Options**:
| Option | Type | Default | Description |
|---|---|---|---|
--option |
boolean | false | Description |
**Examples**:
babysitter example
#### TypeScript APIs
```typescript
/**
* Brief description of what the function does.
*
* @param paramName - Description of parameter
* @returns Description of return value
* @throws {ErrorType} When this error occurs
*
* @example
* ```typescript
* const result = await functionName(arg);
* ```
*/
4. Validate Documentation
- undefined
Output Format
## SDK Documentation Report
### CLI Commands
| Command | Documented | JSDoc | Examples |
|---------|------------|-------|----------|
| `run:create` | Yes | Yes | Yes |
| `run:iterate` | No | No | No |
### Exported APIs
| Export | JSDoc | Types | Examples |
|--------|-------|-------|----------|
| `defineTask` | Yes | Yes | Yes |
### Missing Documentation
1. `packages/sdk/src/cli/commands/newCommand.ts` - No JSDoc
2. `packages/sdk/src/index.ts` - Export `utilFunction` undocumented
### Recommendations
- Add @example to all public functions
- Update README with new CLI commands
Related Agents
Openai Codex CLI
(55.8k ⭐) - Lightweight coding agent that runs in your terminal.
Development community src/agents/ — 11 Agent Definitions
**Generated:** 2026-04-11
Development community Cavecrew Builder
>
Development community Cavecrew Investigator
>
Development community Cavecrew Reviewer
>
Development community Gitnexus Branch Hygiene Reviewer
GitNexus branch hygiene and mergeability reviewer. Use to classify merge state, conflicts, stale branches, merge-from-main commits, unrelated churn, mixed domains, and whether rebase or split is requi
Development community