Technical writing + documentation

Complex technology.
Clear documentation.

I’m Jeff Hanson—a technical writer, published author, and software architect. I turn complex APIs, systems, and engineering concepts into clear documentation that helps people understand, integrate, and maintain software.

DOCUMENTATION / WITH PURPOSEFIELD NOTES
READER-FIRST STRUCTURE

A clear path from
question to action.

  • 01 / UnderstandWhat does this system do, and why does it matter?
  • 02 / UseWhat do I need, and how do I get started?
  • 03 / ResolveWhat can go wrong, and what should I do next?
API GUIDES · ARCHITECTURE DOCS · TUTORIALS
Technical writer & published authorClear explanations for technical audiences
API & developer documentationGuides, tutorials, and integration material
20+ years in engineeringTechnical depth behind the documentation
01 / Documentation services

Clarity is
the deliverable.

From the first integration to a complex system migration, I help turn technical knowledge into documentation people can act on.

01 — DEVELOPERS

API & developer documentation

Getting-started guides, API explanations, integration walkthroughs, and examples. Help developers understand prerequisites, expected behavior, and the next step.

API GUIDESQUICK STARTSINTEGRATION DOCS
02 — SYSTEMS

Architecture & operational documentation

System overviews, architecture decision records, migration guides, and runbooks. Explain dependencies, tradeoffs, and operational procedures without losing the technical substance.

SYSTEM OVERVIEWSDECISION RECORDSRUNBOOKS
03 — UNDERSTANDING

Technical articles & developer education

Tutorials, technical explainers, and learning material that connect concepts to practical use. Adapt the depth and vocabulary to developers, product teams, or business stakeholders.

TUTORIALSTECHNICAL ARTICLESLEARNING MATERIAL
02 / Published work

Books. Articles.
Technical depth in print.

My published work spans enterprise architecture, Java management, application integration, and more than 50 in-depth industry articles for developer publications including JavaWorld, DevX, and IBM developerWorks.

01 / BOOK

Web Services Business Strategies and Architectures

CO-AUTHOR · APRESS · 2003 PRINT EDITION

A multi-author guide to web services architecture and business strategy for architects, developers, and IT leaders. Includes my contribution on .NET and J2EE.

02 / BOOK

Mashups: Strategies for the Modern Enterprise

AUTHOR · ADDISON-WESLEY PROFESSIONAL · 2009

A practical guide to enterprise mashups, covering integration strategies, application patterns, security, and implementation with code examples.

03 / BOOK

Pro JMX: Java Management Extensions

AUTHOR · APRESS · 2004

An in-depth treatment of Java management architecture, instrumentation, distributed services, notifications, and remote management.

A note on the
article archive.

Many original links to my articles are archived or unavailable following changes to their publishing platforms. The book catalogs and surviving articles below provide independently hosted records of my authorship and examples of my technical writing.

Selected articles still available

IBM DEVELOPERWORKS · FEBRUARY 2011 · PDF

An introduction to the Hadoop Distributed File System ↗

An introductory guide to HDFS architecture and its major subsystems. Original article preserved on IBM’s server.

COMPUTERWORLD · JULY 2009 · ARTICLE

Creating mashups: 5 classic mistakes to avoid ↗

A concise discussion of enterprise mashup design choices and common integration pitfalls.

These publications are presented as historical writing samples; technical details reflect their original publication dates.

03 / Writing approach

Useful to the reader.
Faithful to the system.

I approach documentation as a product: define the audience, organize the information around real tasks, and review the technical details with the people responsible for the system.

Documentation with a purpose.

Start with the reader’s task, then provide the context and detail needed to complete it. The same system may need a quick-start guide for a developer and a decision brief for a business leader.

  • API & developer documentationGetting-started guides, integration walkthroughs, and practical examples.
  • Architecture & operational documentationSystem overviews, decision records, migration plans, and runbooks.
  • Technical articles & learning materialTutorials, explainers, and deeper treatments of software concepts.
ILLUSTRATIVE EXCERPT / TWO AUDIENCES

Make the decision understandable.

One architectural choice, explained differently for the people who implement it and the people who approve it.

For an engineering team

Keep the external API contract separate from the internal data model. When storage changes, update the mapping layer rather than asking every client to change with it. Record which behaviors are part of the contract and test them explicitly.

For a business stakeholder

A stable interface can let us improve the system behind it without forcing connected applications to change at the same time. The tradeoff is additional work to maintain that boundary. Choose it when protecting integrations is worth that cost.

New example prepared for this site. Not a prior publication or client deliverable.

04 / Engineering background

Writing informed by
real engineering.

My documentation work draws on hands-on experience with enterprise commerce, insurance, financial software, and platform engineering. This is the technical foundation behind my writing.

01

Enterprise commerce

Max International · Senior Software Engineer & Chief Architect

Enterprise commerce systems, web services, API integration, and Java microservices. Work across development, deployment, and technical architecture.

02

Distributed insurance platforms

eReinsure · Senior Software Engineer & Chief Architect

Distributed reinsurance architecture using Java enterprise technologies, service-oriented integration, XML, and industry-standard data exchange.

03

Financial services integration

Financial Fusion · Technical Lead & Senior Architect

Java-based banking and online bill-payment software, including financial protocols and enterprise application integration.

04

Platform & product foundations

Novell & WordPerfect · Technical Lead & Senior Software Engineer

Platform infrastructure and word-processing software, with responsibilities spanning analysis, design, implementation, and testing.

05 / The person behind the work

A technical writer.
An engineer’s perspective.

01Understand the system before explaining it.
02Make assumptions and tradeoffs explicit.
03Write for the people doing the work.

I’m a technical writer and published author with a software engineer’s understanding of what sits behind the page. My focus is making technical information accurate, useful, and appropriate for its audience.

I offer technical writing and documentation services alongside software development and architecture consulting. I can work with engineers to explain an existing system, build practical learning material, or document a new API as it takes shape.

Outside software, I play guitar, work with wood, and spend time outdoors. I enjoy building things—whether the material is code or lumber.

Connect on LinkedIn ↗
06 / Start a conversation

What needs
to be explained?

Tell me who your readers are, what they need to accomplish, and where your documentation falls short. Include your goals and timeline, and we can start with a focused conversation.

Technical writing · Documentation · Developer education