II.
LibraryProcess JSON
Structured · livelib-process:technical-documentation--sdk-doc-generation
specializations/technical-documentation/sdk-doc-generation json
Inspect the normalized record payload exactly as the atlas UI reads it.
{
"id": "lib-process:technical-documentation--sdk-doc-generation",
"_kind": "LibraryProcess",
"_file": "generated-library/processes.yaml",
"_cluster": "generated-library",
"attributes": {
"displayName": "specializations/technical-documentation/sdk-doc-generation",
"description": "SDK and Client Library Documentation Generation - Automated generation of comprehensive SDK\ndocumentation from code comments (JSDoc, Javadoc, docstrings), including API reference, code examples,\nquickstart 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', {\n projectName: 'PaymentAPI SDK',\n sdkPath: './src/payment-sdk',\n language: 'javascript',\n targetLanguages: ['javascript', 'python', 'ruby', 'go', 'java'],\n includeExamples: true,\n outputFormats: ['html', 'markdown', 'json'],\n hosting: 'github-pages',\n docTooling: 'auto', // 'jsdoc', 'typedoc', 'javadoc', 'sphinx', 'rustdoc', 'godoc', 'auto'\n apiReference: { baseUrl: 'https://api.example.com/v1', spec: './openapi.yaml' },\n branding: { logo: './logo.png', primaryColor: '#0066cc' }\n});",
"usesAgents": [
"jsdoc-tsdoc",
"code-sample-validator",
"markdown-mdx",
"link-validator",
"docusaurus",
"pdf-generation",
"tech-writing-lint"
]
},
"outgoingEdges": [
{
"from": "lib-process:technical-documentation--sdk-doc-generation",
"to": "skill-area:docs-as-code",
"kind": "lib_requires_skill_area",
"attributes": {
"weight": 1
}
},
{
"from": "lib-process:technical-documentation--sdk-doc-generation",
"to": "skill-area:reference-docs",
"kind": "lib_requires_skill_area",
"attributes": {
"weight": 0.7
}
},
{
"from": "lib-process:technical-documentation--sdk-doc-generation",
"to": "domain:software-engineering",
"kind": "lib_applies_to_domain",
"attributes": {
"weight": 1
}
},
{
"from": "lib-process:technical-documentation--sdk-doc-generation",
"to": "role:technical-writer",
"kind": "lib_involves_role",
"attributes": {
"weight": 1
}
},
{
"from": "lib-process:technical-documentation--sdk-doc-generation",
"to": "role:documentation-engineer",
"kind": "lib_involves_role",
"attributes": {
"weight": 0.7
}
},
{
"from": "lib-process:technical-documentation--sdk-doc-generation",
"to": "workflow:documentation-sprint",
"kind": "lib_implements_workflow",
"attributes": {
"weight": 1
}
},
{
"from": "lib-process:technical-documentation--sdk-doc-generation",
"to": "specialization:technical-documentation",
"kind": "lib_belongs_to_specialization",
"attributes": {
"weight": 1
}
}
],
"incomingEdges": []
}