SpillwaveSolutions/document-specialist-skill / skills/documentation-specialist
documentation-specialist
VerifiedThis skill should be used when creating professional software documentation (SRS, PRD, OpenAPI, SDD, architecture docs, user manuals, tutorials, runbooks) from templates (greenfield) or reverse-engineering documentation from existing code like Spring Boot or FastAPI (brownfield). Also handles documentation audits/reviews, format conversion (Markdown, DOCX, PDF), and diagram generation (Mermaid first: C4, sequence, class, ER, state, flowchart; PlantUML Salt for UI wireframes and leftover UML). Use when asked to "create documentation", "document my code", "write SRS", "generate PRD", "write DESIGN_DOC.md", "architecture document", "wireframe", or "documentation specialist".
references/reference/09-code-to-docs-example.md
View on GitHub# Code-to-Docs: Spring Boot to OpenAPI Example
---
TOKEN_BUDGET: 200
TIER: 3
LOAD_TRIGGER: On-demand when demonstrating code-to-docs extraction
DEPENDENCIES: 09-code-to-docs-workflow.md
---
## 9.4 Example: Spring Boot API to OpenAPI
### Input (Java)
```java
@RestController
@RequestMapping("/api/v1/tasks")
public class TaskController {
@PostMapping
@ResponseStatus(HttpStatus.CREATED)
public TaskDTO createTask(@Valid @RequestBody CreateTaskRequest request) {
return taskService.create(request);
}
@GetMapping("/{id}")
public TaskDTO getTask(@PathVariable String id) {
return taskService.findById(id);
}
@GetMapping
public List<TaskDTO> listTasks(
@RequestParam(required = false) String status,
@RequestParam(defaultValue = "20") int limit
) {
return taskService.findAll(status, limit);
}
}
```
---
### Extraction Process
**Step 1: Detect @RestController**
```bash
grep -r "@RestController" src/
# Found: src/main/java/com/example/TaskController.java
```
**Step 2: Extract Endpoints**
- `@PostMapping` → POST /api/v1/tasks
- `@GetMapping("/{id}")` → GET /api/v1/tasks/{id}
- `@GetMapping` → GET /api/v1/tasks
**Step 3: Extract Parameters**
- POST body: `CreateTaskRequest`
- Path param: `id` (String)
- Query params: `status` (String, optional), `limit` (int, default 20)
**Step 4: Extract Response**
- POST returns: `TaskDTO` (201 Created)
- GET returns: `TaskDTO` or `List<TaskDTO>` (200 OK)
---
### Output (OpenAPI)
```yaml
paths:
/api/v1/tasks:
post:
summary: Create a new task
operationId: createTask
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTaskRequest'
responses:
'201':
description: Task created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/TaskDTO'
get:
summary: List tasks
operationId: listTasks
parameters:
- name: status
in: query
required: false
schema:
type: string
- name: limit
in: query
required: false
schema:
type: integer
default: 20
responses:
'200':
description: List of tasks
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TaskDTO'
/api/v1/tasks/{id}:
get:
summary: Get task by ID
operationId: getTask
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: Task details
content:
application/json:
schema:
$ref: '#/components/schemas/TaskDTO'
```
---
### Automation Tools
**Spring Boot**:
- Springdoc OpenAPI (auto-generates OpenAPI 3.0)
- Swagger annotations for customization
**FastAPI**:
- Built-in OpenAPI generation
**Express.js**:
- swagger-jsdoc + swagger-ui-express
---
**End of Spring Boot to OpenAPI Example Guide**
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-analysis-optimizationmorluto/reaOptimize REA providers and shared analysis workflows for agent context, latency, CPU, and memory while preserving correctness and Evidence. Use for analysis bottlenecks and cache or query design; CI/test-suite optimization belongs to rea-ci-tests-audit. | Stars: 471k | Updated | Claude CodeCodex | Verified | Install |
| rea-ci-tests-auditmorluto/reaAudit REA CI and test suites for correctness, fixture drift, false passes, and measured performance; use for suite or workflow investigations and efficiency changes, rather than ordinary feature testing or a single test failure. | Stars: 471k | Updated | Claude CodeCodex | Verified | Install |
| rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics. | Stars: 471k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |