II.
LibraryProcess overview
Reference · livelib-process:sdk-platform-development--api-documentation-system
specializations/sdk-platform-development/api-documentation-system overview
API Documentation System - Implement comprehensive API documentation following Diataxis framework including getting started guides, conceptual guides, how-to guides, and interactive API reference.
Attributes
displayName
specializations/sdk-platform-development/api-documentation-system
description
API Documentation System - Implement comprehensive API documentation following Diataxis framework
including getting started guides, conceptual guides, how-to guides, and interactive API reference.
libraryPath
library/specializations/sdk-platform-development/api-documentation-system.js
specialization
sdk-platform-development
references
- - Diataxis Documentation Framework: https://diataxis.fr/
- - Google Developer Documentation Style Guide: https://developers.google.com/style
- - Write the Docs: https://www.writethedocs.org/guide/
example
const result = await orchestrate('specializations/sdk-platform-development/api-documentation-system', {
projectName: 'CloudAPI',
apiSpecPath: './openapi.yaml',
documentationFramework: 'docusaurus',
interactiveConsole: true
});
usesAgents
- dx-content-writer
- platform-architect
- tutorial-builder-agent
Outgoing edges
lib_applies_to_domain1
- domain:software-engineering·DomainSoftware Engineering
lib_belongs_to_specialization1
- specialization:sdk-platform-development·Specialization
lib_covers_topic2
- topic:api-design·TopicAPI Design
- topic:developer-experience·TopicDeveloper Experience (DX)
lib_implements_workflow1
- workflow:sdk-release-lifecycle·WorkflowSDK Release Lifecycle
lib_involves_role1
lib_requires_skill_area3
- skill-area:sdk-codegen·SkillAreaSDK Code Generation
- skill-area:api-clients-sdks·SkillAreaAPI Clients and SDKs
- skill-area:api-doc-generation·SkillAreaAPI Doc Generation
uses_agent3
- lib-agent:sdk-platform-development--dx-content-writer·LibraryAgentdx-content-writer
- lib-agent:sdk-platform-development--platform-architect·LibraryAgentplatform-architect
- lib-agent:sdk-platform-development--tutorial-builder-agent·LibraryAgenttutorial-builder-agent
Incoming edges
None.