Technical Writing and Documentation

TECHNICAL KNOWLEDGE AND CLARITY

A Product Leader, Software Architect and Consultant will do a lot of important writing. Over my career I've authored documentation, sales materials, presentations, user stories, case studies, white papers and more! 

As a skilled writer with detailed knowledge of the technology, my clients and employers have turned to me when clear and technically accurate materials were needed.

TechWriting.jpg
 

Writing for Developers

DOCUMENTING API, CODEBASE, DATABASE, ARCHITECTURE

As an experienced software and database developer and designer, I've worked directly with teams of developers, and  have documented all aspects of the technlogy stack, before, during and after the development process.

  • Familiar with C++, C#, Python, Java Javascript, HTML, SQL, Scala, and others

  • Authored to Web/HTML, PDF, Markdown, reSructurred Text, Video

  • API guides, User Stories, Code Specifications, Data Dictionaries, Test Guides and Test Results.

  • Re-authoring docs written by offshore teams (ESL)

 

Writing for Users

TRAINING AND GUIDING USERS THROUGH NEW APPLICATIONS AND DATA PRODUCTS

  • User Guides

  • Training Materials

  • Video training and on-boarding

  • Pre-sales app description and use cases

See examples
 

Writing for Customers

DESCRIBING TECHNICAL PRODUCTS TO PROSPECTS

  • White Papers

  • Case Studies

  • Marketing Materials - Product Sheets

  • Demos - live, recorded, in document

  • Product Vision documents

See Examples
 

Writing Samples

Most tech writing examples are locked in internal distribution or protected by NDA, but below are some I am able to share. Business names have been changed and few other elements disguised, but the nature of the work should be clear.

A RESTful API accessed through network, used to integrate AcquireWeb systems to a partner's syste, to empower a product of theirs. An adaptation of an API used internally and eventually revised and expanded to other partners and customers.

A client with a new application in beta release found that their web developer had not anticipated how the appliction could scale to much larger customers, or even to multiple customers. This client asked Innomark (Jay) to review the app, as it existed what was planned, and make recomendation for a more sophistocated data storage solution.

Engaged to test and validate the database underlying an online training application, Jay performed the testing and wrote the report, a portion of which is provided here.

After release of a new feature to MS SQL Server, This document, in style a user guide, was published as a white paper and as an addition to a training program also authored by Jay. It descibes a new, advanced approach to multidimensional security permissions

 

OTHER WRITING

  • Bitcoin, Cybercurrencies and blockchain - a technical backgrounder (Coming Soon)

  • Key Concept in Data (Coming Soon)

  • General opinion writing

  • Sailboat Racing Reports