II.
LibraryProcess overview
Reference · livelib-process:technical-documentation--sdk-doc-generation
specializations/technical-documentation/sdk-doc-generation overview
SDK and Client Library Documentation Generation - Automated generation of comprehensive SDK documentation from code comments (JSDoc, Javadoc, docstrings), including API reference, code examples, quickstart guides, integration tutorials, and multi-language SDK support following documentation best practices.
Attributes
displayName
specializations/technical-documentation/sdk-doc-generation
description
SDK and Client Library Documentation Generation - Automated generation of comprehensive SDK
documentation from code comments (JSDoc, Javadoc, docstrings), including API reference, code examples,
quickstart guides, integration tutorials, and multi-language SDK support following documentation best practices.
libraryPath
library/specializations/technical-documentation/sdk-doc-generation.js
specialization
technical-documentation
references
- - JSDoc: https://jsdoc.app/
- - TypeDoc: https://typedoc.org/
- - Javadoc: https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html
- - Sphinx: https://www.sphinx-doc.org/
- - Doxygen: https://www.doxygen.nl/
- - rustdoc: https://doc.rust-lang.org/rustdoc/
- - Godoc: https://go.dev/blog/godoc
- - Docusaurus: https://docusaurus.io/
- - Documentation Best Practices: https://documentation.divio.com/
example
const result = await orchestrate('specializations/technical-documentation/sdk-doc-generation', {
projectName: 'PaymentAPI SDK',
sdkPath: './src/payment-sdk',
language: 'javascript',
targetLanguages: ['javascript', 'python', 'ruby', 'go', 'java'],
includeExamples: true,
outputFormats: ['html', 'markdown', 'json'],
hosting: 'github-pages',
docTooling: 'auto', // 'jsdoc', 'typedoc', 'javadoc', 'sphinx', 'rustdoc', 'godoc', 'auto'
apiReference: { baseUrl: 'https://api.example.com/v1', spec: './openapi.yaml' },
branding: { logo: './logo.png', primaryColor: '#0066cc' }
});
usesAgents
- jsdoc-tsdoc
- code-sample-validator
- markdown-mdx
- link-validator
- docusaurus
- pdf-generation
- tech-writing-lint
Outgoing edges
lib_applies_to_domain1
- domain:software-engineering·DomainSoftware Engineering
lib_belongs_to_specialization1
- specialization:technical-documentation·Specialization
lib_implements_workflow1
- workflow:documentation-sprint·WorkflowDocumentation Sprint
lib_involves_role2
- role:technical-writer·RoleTechnical Writer
- role:documentation-engineer·RoleDocumentation Engineer
lib_requires_skill_area2
- skill-area:docs-as-code·SkillAreaDocs-as-Code
- skill-area:reference-docs·SkillAreaReference Documentation
Incoming edges
None.