This is my basic process for creating technical documentation. Often I use it as a foundation and modify it to meet particular client and project requirements.
Creating Low-Code Loan Applications using the Trisotech Mortgage Feature Set
The Will Kelly Technical Writing Process
1. Will Kelly’s Technical Writing Process
Outline/ Write First Editorial/ Customer Final
Planning/ Draft Technical Final Publishing
Research Review Review/ of Doc
Approval
• Create outline • Write first • Opportunity • Customer • Final
and/or draft of for writer, review of document is
documentation document SME, and document delivered in
plan • Continue customer • Any final agreed upon
• Establish research as interaction changes or format(s)
project needed • Editorial revisions • Document
schedule • SME/PM review required archived in
• Establish interaction follows • Signoff/ version
technical as needed agreed approval by control
review upon customer
guidelines guidelines &
• Establish schedule
access needs
Process is flexible and may be changed depending on particular customer and project requirements.