Penman Communications, LLC.

Specializing in technical writing, online learning development and graphic design services.

  • Home
  • About Us
    • Company Overview
    • Frequently Asked Questions
    • Penman Testing
  • Services
    • Technical Writing
    • Graphic Design
    • Custom eLearning Solutions & CBT Development
    • Technical Editing
    • Instructional Design
    • Audio Recording
    • Technologies
  • Clients
  • Our Work
  • Blog
  • Contact Us
You are here: Home / Writing Resources / Technical Writing – High Level Project Plan

Technical Writing – High Level Project Plan

Phases and Working Methodology

The development of content for manuals and help system typically goes through these phases:

• Analysis
• Establishing Agreements and Goals
• Input
• Writing
• Proofreading
• Editing
• Engineering and Testing
• Delivering Presentable Product (beta)
• Final evaluation
• Delivery

Analysis

During this phase the writer and customer will discuss the scope of the project, the set up, the detail level, the layout of the various types of output, and consider any other unique requirements.

A estimate for the time necessary to complete the project is determined on an hourly or fixed-price by basis.

Establishing Agreements and Goals

PenMan Communications develops the Statement of Work based on the Analysis phase. Once the parties have agreed on the services and costs, the SOW is signed and work begins.

Input

In the input phase the client and SMEs provide the technical writer with input on the operation of product or service. The transfer of knowledge can take place with personal interviews (with or without recording equipment), the use of existing documentation such as system design documents, release notes, training materials and any other available information.

Writing

On the basis of the input received, the technical writer will develop the content.

Client Review

When the writer has finished a concept, it will be handed over to the SME for initial review and confirm the flow and accuracy of the material. The comments are used to update the material.

Pages: 1 2 3

Core Services

  • Technical Writing
  • Technical Editing
  • Graphic Design
  • CBT Development & E-learning Courses

Writing Resources

  • 100 Commonly Misspelled Words
  • A Grammar Primer
  • Writing Tools
  • Words That Sound Alike
  • Editing Resources
  • Technical Writing – High Level Project Plan

Company Overview

Based in Charlotte, we provide services for across the US.  We provide Technical … More

Writing Resources

There are many resources on the internet that will assist you when writing or editing … More

Examples of Our Work

At PenMan, we view graphic design as an integral part of targeted, compelling, marketing and … More

© 2022 Copyright Penman Communications LLC. All Rights Reserved.