Methodology
Delivery Models
Methodology
We consult with our clients to determine their business needs and desired outcomes. Then our consulting team scopes the project, designs the ideal solution, manages the work, and delivers to client specifications. We can perform the work in our offices or provide a combination of onshore work and skill-level offshoring. Both of these models enable clients to focus on their core competencies while we focus on ours: deliver compelling and powerful content solutions that meet our clients' business needs.
Delivery Models
This section describes the activities for technical documentation, and the staffing mix of technical writers. Our flexible engagement models can be tailored to your need for better speed, lower cost and higher quality.
Model 1 OutsourcingTechTotal can work collaboratively with your team and provides the necessary people, process and technology to effectively outsource your documentation needs while your teams focus on design and development. We have the capability to understand complex IT products and can develop appropriate documentation for specific audiences and purposes. TechTotal can provide these services on a Fixed Bid model or Time & Material model, as needed.
Model 2 1. Technical Writer - Onsite- Works with the client team to study the product, the technology, and elicit documentation requirements
- Interacts with business analysts, architects of the system and the project managers
- Activities include the information design, development of the outline of content and approval process
- Creates templates and co-ordinates with developer resources and subject matter experts for reviews
- Develop graphics, illustrations, maintain screen captures, versioning and maintenance of the delivered documents.
- Format and publish to various outputs and manage risks
- Interacts with business analysts, architects of the system and the project managers
- Provide editorial reviews, guide team with best practices,conduct weekly reviews and analyze doc metrics
Most of our source information comes from your design specifications, interviews with your product designers, our existing knowledge of your technology, competitive or prior-art documents and if applicable use of your product.
We normally begin with background reading of your design specifications and competitive or prior-art documents. During this reading, we generate notes that form the basis for interviews and the beginning of our writing.We conduct interviews with your product designers and marketing staff. The interviews can be conducted on-site or by email/telephone. If possible, we use your product.
WritingWhen we understand your product, we begin organizing, writing, and illustrating. During the writing, we focus on clear organization, accuracy, and completeness. We write using industry-standard terms, so that readers can understand it quickly. We create tables comparing data, cross-references, and indexes that help readers random-access the content quickly. And we observe laws protecting trademarks and copyrights.
We use the most robust, cross-platform software tools for writing, illustration, and page layout. These tools and the file formats they export, are widely used throughout industry. After we write, we edit to improve clarity and reading speed. After our edits, we deliver Draft Version for your review.
ReviewsWe typically prepare two review drafts - Rough Draft and final Draft; before delivering the final document. All review drafts are fully formatted. You can show them to your customers. When we receive your comments on Draft Version, we incorporate them and deliver Draft Version 2. Likewise,we incorporate your Draft Version 2 comments and deliver the final document.
Document OwnershipYour company owns the technical documents we write for you. We declare this in our contract with you and in a copyright notice on the cover of each document that we write for you. We give you a complete set of computer files for the documentation at the end of the project.
DeliveryWe deliver the final document in a format suitable for your needs. We can create PDF, HTML, hardcopy (camera-ready), online Help and other formats.