Banner Image

All Services

Writing & Translation technical

SDK & Library Documentation

$115/hr Starting at $200

I write SDK and library documentation that gets developers productive in minutes — starting with a README that delivers a working first result fast, through to a complete method reference written from your source code.

Documentation components: README (installation, authentication, quickstart with actual working code, key concepts, common use cases, error handling — everything to get to first success in under 10 minutes); method and class reference (every public method with parameter types, return values, exceptions thrown, and a tested usage example); conceptual guides (design patterns the library encourages, when to use which approach, common pitfalls); tested code examples for real use cases; structured changelog entries; and major version migration guides.

Languages: Python (Sphinx, pdoc, or Markdown), JavaScript/TypeScript (JSDoc, TypeDoc), Go (godoc), Java (Javadoc), Ruby (YARD), PHP (phpDocumentor). Documentation is generated directly from source code where tooling supports it — not written in isolation from the code.

Share your GitHub repository and I'll document from the source code and tests. Code examples are tested before delivery.

About

$115/hr Ongoing

Download Resume

I write SDK and library documentation that gets developers productive in minutes — starting with a README that delivers a working first result fast, through to a complete method reference written from your source code.

Documentation components: README (installation, authentication, quickstart with actual working code, key concepts, common use cases, error handling — everything to get to first success in under 10 minutes); method and class reference (every public method with parameter types, return values, exceptions thrown, and a tested usage example); conceptual guides (design patterns the library encourages, when to use which approach, common pitfalls); tested code examples for real use cases; structured changelog entries; and major version migration guides.

Languages: Python (Sphinx, pdoc, or Markdown), JavaScript/TypeScript (JSDoc, TypeDoc), Go (godoc), Java (Javadoc), Ruby (YARD), PHP (phpDocumentor). Documentation is generated directly from source code where tooling supports it — not written in isolation from the code.

Share your GitHub repository and I'll document from the source code and tests. Code examples are tested before delivery.

Skills & Expertise

Concept DevelopmentDocBookDocument DesignEvaluation DesignGitHubGo ProgrammingInformation TechnologyJavaJavaDocPHPProgrammingPythonTechnical EditingTechnical WritingTooling DesignWebsite Migration

0 Reviews

This Freelancer has not received any feedback.