Technical Writing Process Checklist

Purpose and Scope.

This checklist defines the Logistics Technical Publications Technical Writing content development process
for Technical Manuals (TMs), Depot Maintenance Work Requirements (DMWRs), National Maintenance
Work Requirements (NMWRs), Modification Work Orders (MWOs), Technical Orders (TOs), Time
Compliance Technical Orders (TCTOs), and other publication types.
No Action Reference Date
. Completed
Pre-Writing Considerations
Fully identify the end item(s) (nomenclature,
model, serial number, part number, etc.) to
which the technical content will be written.
2 Gather Source Data
Drawings
PIf Docs
GFI
Determine from the project SOW (Statement of MIL-STD-40051
Work) and CDRLs (Contract Data Requirements TM/DMWR/NMWR/PMI/PMS/PMD,
List) the type of publication(s) that is required. MIL-PRF-63002 MWO, MIL-PRF-63029 -
Technical publications are developed utilizing 10/-CL/-MTF, Commercial Off the Shelf
guidance from applicable military standards (COTS)
and Extensible Markup Language (XML) along
with government developed Document Type Installation instructions will use MIL-
Definitions (DTD) and stylesheets. Technical PRF-63002 and COTS technical manuals
publications consist of technical content from will use MIL-STD-40051 unless a
the Technical Writer, illustration source files customer requires a specific file format
from the Illustrator, and XML source files that that is defined in the SOW and CDRLs.
create the actual publication from the
Publications Development (Pubs Dev) XML
department. The deliverable file formats are
typically either an IETM or a PDF (Portable
Document Format) generated from the XML
source files and illustration source files.

COTS publications are typically written in

contractor format. The Yulista contractor
format is XML source files depending on the
publication type. Download a copy of YF-LOG-
14 Technical Writing Review Checklist from the
Quality Management System (QMS) site and
upload to the Tech Writing folder for the new
project. YF-LOG-14 is required to start the
project and follows the publication(s) from
inception to end.
 Technical Writing Process Checklist

Modification Work Order (MWO)

When a project requires an MWO, the MIL-PRF-63002
Technical Writer should follow the guidance of
this section. Additionally, each Program
Management Office (PMO) may have unique
guidance for MWOs. Check with your
supervisor if you have questions or concerns
about customer guidance.

Not all MWOs require Maintenance Engineering Test Plan Documentations

Operational Checks (MOCs). The engineers will
develop a separate Acceptance Test Plan (ATP)
that can be used as the basis for the MOC.

The Technical Writer shall coordinate with the LSA-126 Report

Provisioner to request a BOM report.
Provisioning uploads the BOM report to the
Provisioning folder in Log SP and notifies the
Technical Writer of the initial upload. Each time
the BOM report is updated, the Provisioner
checks out the existing BOM in Log SP, uploads
the new BOM, and notifies the Technical
Writer.

Refer to the military specification in the SOW TM, IETM, DMWR, NMWR, -10, MTF,
for definition of each publication type and its CL, PMS/PMI/PMD, etc.
requirements.

When Provisioning/Logistics Analysis with

Maintenance Allocation Chart (MAC) data is a
requirement for a project, the Provisioner on
the project coordinates with the Pubs Dev XML
department for development of the MAC work
package. After the MAC data is generated by
Provisioning/Logistics Analysis, it is uploaded to
SharePoint for usage by the Technical Writing
department and the Pubs Dev XML
department. The Technical Writer will use MAC
data to determine level of maintenance needed
and number and type of maintenance tasks to
be written.

When Provisioning with RPSTL data is a

requirement on a project, the Provisioner on
the project coordinates with the Pubs Dev XML
department for development of the RPSTL,
 Technical Writing Process Checklist

NSN, and P/N work packages. The Provisioner

coordinates with the Illustrator for RPSTL
illustrations. The Technical Writer is not
responsible for developing any RPSTL data or
work packages. Subsequent writing and editing
(versions/revisions) of the document should
occur only to this version-controlled document
and all versions/revisions shall be uploaded and
managed on a daily basis IAW the guidance of
editing data within the CMS IAW SOP-LOG-01.
Upload and maintain all relevant materials and
resources in appropriate locations within the
CMS. Ensure that all documentation is
watermarked with appropriate status.

The Technical Writer must provide a weekly

status update along with a report of any
significant events that have occurred during the
past week to the Tech Writer Supervisor.

At the start of a project, Supervision creates a

group email to include all contributing Logistics
personnel. This group email is provided to the
entire Logistics project team as well as the
Project Manager and Project Lead. Use the
email group for any and all project-related
email communications. Any contributing
personnel may update the email group
throughout the life of the project. All project-
related verbal communications will be
distributed via the email group so that all
contributing personnel are aware of any
pertinent updates, information, or changes.

Engineering updates, authoritative guidance,

event updates, peer and editor reviews result
in changes that will continue throughout the
development of technical content.
 Technical Writing Process Checklist

Pre-Prototype Draft Publication

Prototype is considered an Engineering function; however, it is the first event where the Technical Writer
has the opportunity to gather significant data to create content for the publication. The following
checklist shall be performed in conjunction with the Logistics Publication Work Flow Process.
3 Pre-Prototype Draft Development
Obtain MWO,TM Template
Start Pre-Prototype Development
Paragraphs 1-9 Mil-STD 63002L
Paragraph 10 Mil-STD 63002L
Consistency
Maintenance Operational Check (MOC) Eng ATP
Paragraph 11-16 Mil-STD 63002L
Water Mark “Pre-Prototype Draft Date SOW may designate the exact
(Ex: 6/6/2018)”. All publications watermarks watermark wording
must include the date of release (delivery).
Supervisor Review Publication Work Flow
Attend Prototype Event
Ensure completion of Logistics
Prototype/Validation Attendance Sign-In
Sheet daily.
At the end of the event, ensure Logistics
Publications Concurrence form is completed
and signed by all participants
Redline drawing review with ALCON Publication Work Flow
Incorporate redlines from Prototype Event Eng Drawings, Notes
Water Mark “PROTOTYPE DRAFT DD Month SOW may designate the exact
Year; (Ex: 6/6/2018)”” This is the version post watermark wording
prototype installation. This version will include
identified, but unincorporated text, and
illustration redlines that were identified during
the prototype installation. All publications
watermarks must include the date of release
(delivery).

Validation
Validation is a contractor event (i.e. Technical Writer). Project lead/management sets up the event. The
validation of the publications is conducted by the Technical Writer. The following checklist shall be performed
in conjunction with the Logistics Publication Work Flow Process.

Attend Validation Event

Ensure completion of Logistics
Prototype/Validation Attendance Sign-In
Sheet daily.
 Technical Writing Process Checklist

Ensure event stays on task, is completed on

time, and all publications have been fully
validated.
Table top/line-by-line review is conducted at
the end to ensure capture and agreement to all
redlines.

At the end of the event, ensure Logistics

Publications Concurrence form is completed
and signed by all participants
Redline drawing review with ALCON Publication Work Flow
Technical Writer is responsible for preparing Statement of Work (SOW)
and submitting a Validation Report after the
completion of the validation.

Incorporate redlines from Validation Event Eng Drawings, Notes

Water Mark “Validated DRAFT DD Month Year; SOW may designate the exact
(Ex: 6/6/2018)” This is the version post watermark wording.
validation installation. This version will include
identified, but unincorporated text, and Publication Work Flow
illustration redlines that were identified during
the prototype installation. All publications
watermarks must include the date of release
(delivery).

Technical Writer is responsible for preparing Statement of Work (SOW)

and submitting a Validation Report after the
completion of the validation.

Verification
Verification is a Government-controlled event. Logistics supports the event by ensuring the following:

At the end of the event, ensure Logistics

Publications Concurrence form is completed
and signed by all participants