II.
LibraryProcess JSON
Structured · livelib-process:technical-documentation--api-reference-docs
specializations/technical-documentation/api-reference-docs json
Inspect the normalized record payload exactly as the atlas UI reads it.
{
"id": "lib-process:technical-documentation--api-reference-docs",
"_kind": "LibraryProcess",
"_file": "generated-library/processes.yaml",
"_cluster": "generated-library",
"attributes": {
"displayName": "specializations/technical-documentation/api-reference-docs",
"description": "API Reference Documentation with Code Examples - Comprehensive process for creating complete API reference\ndocumentation with multi-language code examples, authentication flows, error handling, rate limits, SDK integration guides,\nand interactive API explorers following documentation best practices.",
"libraryPath": "library/specializations/technical-documentation/api-reference-docs.js",
"specialization": "technical-documentation",
"references": [
"- Google API Documentation Best Practices: https://cloud.google.com/apis/design",
"- Microsoft API Documentation Guidelines: https://github.com/microsoft/api-guidelines",
"- OpenAPI Specification: https://swagger.io/specification/",
"- Stripe API Documentation: https://stripe.com/docs/api",
"- Twilio API Documentation: https://www.twilio.com/docs/usage/api"
],
"example": "const result = await orchestrate('specializations/technical-documentation/api-reference-docs', {\n apiName: 'E-Commerce Platform API',\n apiType: 'REST',\n specificationPath: 'specs/openapi.yaml',\n endpoints: [\n { path: '/products', methods: ['GET', 'POST'] },\n { path: '/orders', methods: ['GET', 'POST'] }\n ],\n targetLanguages: ['javascript', 'python', 'java', 'ruby', 'go'],\n targetAudience: 'external-developers',\n authType: 'OAuth2',\n includeInteractiveExplorer: true\n});",
"usesAgents": [
"openapi-swagger",
"markdown-mdx",
"code-sample-validator",
"jsdoc-tsdoc",
"readme-platform",
"tech-writing-lint"
]
},
"outgoingEdges": [
{
"from": "lib-process:technical-documentation--api-reference-docs",
"to": "skill-area:docs-as-code",
"kind": "lib_requires_skill_area",
"attributes": {
"weight": 1
}
},
{
"from": "lib-process:technical-documentation--api-reference-docs",
"to": "skill-area:reference-docs",
"kind": "lib_requires_skill_area",
"attributes": {
"weight": 0.7
}
},
{
"from": "lib-process:technical-documentation--api-reference-docs",
"to": "domain:software-engineering",
"kind": "lib_applies_to_domain",
"attributes": {
"weight": 1
}
},
{
"from": "lib-process:technical-documentation--api-reference-docs",
"to": "role:technical-writer",
"kind": "lib_involves_role",
"attributes": {
"weight": 1
}
},
{
"from": "lib-process:technical-documentation--api-reference-docs",
"to": "role:documentation-engineer",
"kind": "lib_involves_role",
"attributes": {
"weight": 0.7
}
},
{
"from": "lib-process:technical-documentation--api-reference-docs",
"to": "workflow:documentation-sprint",
"kind": "lib_implements_workflow",
"attributes": {
"weight": 1
}
},
{
"from": "lib-process:technical-documentation--api-reference-docs",
"to": "specialization:technical-documentation",
"kind": "lib_belongs_to_specialization",
"attributes": {
"weight": 1
}
}
],
"incomingEdges": []
}