It’s strange to some, but I truly enjoy creating good documentation. To me, creating quality documentation is a puzzle – where the goal is communicate all necessary information, but do so in an ordered and organized way so that the reader gets the information they need, when they need it.
This often means blending both macro and micro concepts; going into sufficient detail to anticipate the audience’s needs and questions – but also not drowning the reader or frustrating them with incomplete or non-linear information.
Not doubt, working on documentation can feel like a burden when shipping software is the primary focus. But lack of sufficient documentation is a technical and business debt with recurring interest paid in inefficiency.
Whether your documentation needs are:
- On-boarding new team members
- Creating a reference for software maintenance and support teams
- Educating non-technical stakeholders
- Fulfilling infosec compliance or audit requirements
- End user training
- Managing the intake and review process for teams of technical writers
Strand Consulting has the technical and business knowledge necessary to support your needs.
Below you will find additional reading about my approach to technical documentation.
Anatomy of a Bluetooth App
When I first started blogging at strandcode.com, one of my most popular posts was Breaking Down Bluetooth in Objective-C. I think it stands today as a good example of balancing both a macro and micro explanation of complex application.
Approach and Anatomy of a Feature Specification
In my experience, good product managers are good writers. In this post I’ll share an example feature specification that I wrote and discuss how it is used by various audiences.