3. Introduction
This paper presents the value and need for quality TWB – Leading Technical Documentation
Technical Publications in companies providing
Networking Infrastructure Solutions.
Outsourcing Company
TWB is a leading technical publisher with an excellent
Technical Publications include a wide variety of
record of providing unmatched technical documentation
material such as Process documents, Workflows, User
to many major companies.
Guides, online Help files, White Papers, Training
Manuals, Reference Guides, Administration Guides,
Standard Operating Procedures, Installation Manuals, TWB is the ideal choice for leading Networking Solution
Web-based Training Materials, and Product Demos. providers. TWB helps customers with all their technical
documentation needs such as user guides,
administration guides, installation manuals, process and
Setting up a Networking Infrastructure involves a
workflow documentation, configuration documents, and
series of activities ranging from selecting a suitable
training materials.
network topology to optimizing the network
performance and at the same time keeping the
network secure. Adequate documentation is TWB works closely with client teams located globally,
imperative to completely reinstate a networking and assists them in meeting their worldwide product
environment in case of a disaster. Documentation with announcements and launch deadlines. We work round-
accurate details makes regular maintenance fast and the-clock with client teams and provide them with quick
efficient. This necessitates documentation of critical responses that facilitate timely distribution of documents
processes and workflows, along with the creation of around the globe.
user manuals for the hardware and its modules,
training material for employees, and product-specific “Knowledge is people, money, learning, flexibility
configuration documents. and competitive advantage. Knowledge is more
relevant to sustained business than capital or labor.
And yet knowledge remains the most neglected
"The recovery of the global economy will drive growth
asset of a business. TWB helps you unlock and
in the worldwide enterprise network infrastructure
share your technical knowledge with the world.”
spending. The growth in storage and devices on the
network coupled with the mission criticality of the
network will spur customer investments," says Lucinda
Borovick, Research Vice President, IDC.
However, despite the rapidly increasing growth of
Networking Infrastructure solutions, the criticality of
network documentation before embarking on a design
or redesign is undermined. The complexity of the
implementation of the hardware makes quality
documentation important to both the vendors of
Networking Solutions and organizations that purchase
them. Hence, documentation needs to be simple and
lucid, which calls for the involvement of Technical
Documentation Specialists.
“TWB believes that technology cannot exist
without being communicated effectively.”
The Writers Block www.twb.in 1
4. Networking Solutions – Technical Publications
Global Growth and Penetration of Challenges and Solutions
Networking Solutions
According to a latest research report from Cisco Some of the significant documentation challenges
Systems, Global IP traffic will quintuple from 2009 to most companies face today are:
2013 and the Internet will be nearly four times larger in
2013 than it is in 2009. Documentation for global audience
“IP traffic will grow at a CAGR of 40% over the next The need for high-quality documentation to reduce
few years and will exceed two-thirds of a zettabyte support costs
(667 Exabyte’s) by 2013,” Cisco predicts. Lack of detail to make regular maintenance fast
and efficient
New forecast in the latest edition of the Wireless Sensor
Network Technology Trends Report projects strong Modern enterprises depend on network availability
market growth in the market for Low Power WiFi for business continuity. In heterogeneous networks,
chipsets to reach 322% CAGR, over the 2008 to 2013 administrators face numerous challenges in
period. appropriately managing device configurations,
carrying out changes, ensuring compliance to
Exponential growth of this nature directly translates to
regulations, and minimizing network downtime
increase in networking infrastructure spending.
triggered by human errors.
We at TWB are equipped with impeccable
documentation skills. Network administrators who
have utilized our network documentation as a “living
document” or “living process” have undoubtedly
reaped the benefits. Also, service providers have
leveraged this detailed of a binder as their project
deliverable to rise above the competition.
Benefits
Growth and Penetration of Networking
Partnering with TWB has proved to be profitable for
Solutions – India
companies that provide Networking Infrastructure
According to Subashini Prabhakar, CTO, DAX solutions. Efficient documentation has resulted in
Networks, vast potential lies in the networking market. these companies saving time, money and
She says, "The Indian market is moving toward resources.
adopting a high performance network as business
demand more from IT. Today, performance of a With TWB, Networking Infrastructure providers
network has matured more than ever before and the discover key benefits such as:
criterion for buying and operating has changed
dramatically. The Indian market is booming with high Self-reliant documents and stand-alone
PC penetration, helping to buy out the IT, ITeS, and references authored to service the client’s
BPO segments. Convergence of voice, video and unique needs
applications is drawing up huge investments in high Flawless documentation that adheres to
performance networks." industry best practices
Accurate documentation of business continuity
plans to keep end users productive in the event
The market for enterprise networking equipment of a network failure
in India will grow from an estimated US$1 billion in
2008 to US$1.7 billion by 2012, corresponding to a
(CAGR) of 15% through this period, says a latest
research study from Springboard Research.
The Writers Block www.twb.in 2
5. Value of Technical Publications
Technical Communication for Communication for Different Levels of
Transferring Product Knowledge Technical and Product Knowledge
The purpose of technical communication is to transfer In technical publications, audience is the focal point.
product knowledge to end users in a comprehensible Hence, the style, language, and content must vary
manner. The strategies of communication and levels of depending on the type of audience being addressed. It
information vary depending on the type of product and is because every user has a specific role in the
audience. implementation and usage of the technology.
Therefore, it is important that documents be created
Providing end users with information about a product’s keeping in mind the role of the person who will use the
operation and maintenance is critical to the market document.
performance of the product. Hence, the need for quality
documentation is imperative. For example, when you document a software
application designed for highly technical users, it is
In today’s business scenario, technical publications are sufficient to provide the users with quick reference
often developed as an afterthought. This usually results information to use the application.
in inaccurate and incomprehensible documentation,
which, in turn, renders the users incapable of using the For users who start without technical or product
products. knowledge, it is important to provide detailed product
information along with instructions on how to use the
Accurate, readily understandable, and quality documents product.
determine how a product sells in the market and results
in increased customer satisfaction. Attractive Publications as Useful
Marketing Tools
Faulty Assumptions that Result in Besides transferring knowledge, technical publications
Problems in Documentation are also used for marketing a product. Before a
product is released in the market, information about
The faulty assumptions listed below result in the product needs to be effectively communicated to
incomprehensible document: the customers.
Developers know their products better than anyone Well-designed, accurately presented, and attractive
else – due to time constraints and limited resources, marketing collaterals increase the market prospects of
many companies assign their documentation tasks to a product and reduce support costs.
the programmers. This more often results in the
creation of technology-centered information, while
end users require task-oriented information.
Documentation of complex applications requires a
longer learning curve for the writer - learning the
product will not be a major obstacle for writers with
the right technical background.
The Writers Block www.twb.in 3
6. Conclusion
Networking Infrastructure Solutions are business enablers: Networking Infrastructure is an essential, core
enabler of online business. The modern business paradigm of delivering highly personalized service to individual
consumers’ demands that Networking Infrastructure is at the core of the business process.
Value of Technical Publications is irreplaceable: Technical Publications are vital for the transfer of product
knowledge to the end-users. Adequate material to use the technology and products enables the user to accept
and efficiently use the product in question. Faulty documentation leads to inaccurate and hard-to-understand
material and also decrease the chances of marketing the products in the global markets.
Documentation Outsourcing is the answer: Having detailed network documentation created is the practice of
a good custodian of that network. A good baseline or a solid understanding of the current network topology will
speed the ability to bring the network back online during a failure. To counter the complexity involved in creating
efficient network documentation vendors and purchasers, outsourcing the documentation needs to well-
established Technical Publications Solutions providers is the answer. This helps companies cut costs and, at the
same time, deliver their products with quality documents.
The Writers Block www.twb.in 4
7. TWB Services
TWB is India’s leader in technical communication outsourcing and education. TWB offers a complete suite of services that allow
our customers to effectively publish their technical knowledge with their people and processes. TWB’s customers range from
Global 500 – including Cisco, Accenture, McAfee, LG, Samsung, Citrix, SAP, Siemens, AOL, Intel; Indian technology majors –
including Infosys, Wipro; Global defense majors - Pratt & Whitney, Honeywell, DRDO, HAL; and exciting technology startups.
TWB's expertise in technical communication ranges from IT Products and Outsourcing, ITES, Banking, Financial, Aerospace,
Defense, Ship Building to Hi-tech Manufacturing, and Discrete and Process Manufacturing.
TWB’s services include:
Technical Marketing Technical Product Documentation Quality
Solutions Documentation Management
Datasheets
Administrator’s Guide
Datasheets Copy Editing and Proof Reading
API Document
Cheat sheets Managing Writing
Configuration Guide
Solution Briefs/Solution Brochures Editing Services
Functional Specifications Document
Presentations – Products/Corporate Layout and Design
Profile Installation Manual
Creating SLAs
Brochures and marketing collateral Interface Document
Web content Interactive Electronic Technical Manual
(IETM)
Business Documentation
Audio and video scripts
Maintenance Manual Business Proposals
Press releases
Online Help Legal Disclaimers
Direct mail
Operation Manual Policy Manuals
Newsletter design copy
Product Demo Style Guide Design
Sales catalogues
Product Specifications Document Template Design
Sales sheets
Product Overview Document
Quick Reference Guide
Business Communication Content Management
Release Notes
Short Reports Requirement Analysis Document
Single Sourcing
Proposals SDK Document
File Version Control
Case Studies Troubleshooting Manual
Document Naming Conventions
Lab Reports User Manual
Consistent Document Formatting
Memos Open Source Documentation
Data Transformation
Progress/Interim Reports Programmers Guides
Writing for Electronic Media Functional Specifications Document
Use Cases Web site Development
Illustrations Online Help /Context Sensitive Help
Web 2.0 development
Troubleshooting Guides
Graphic Designing Web content
Info graphics Web applications
Qualitative Analytics for
2D & 3D animation
Decision Support Translation and Localization
Line drawings and illustrations
Services
Economic Business Research
Process Documentation Industry Analysis Software Translation Services
Workflows Market Opportunity Analysis Document Translation Services
Standard Operating Procedures Competitive Business Analysis Localization (L10N) Testing
ISO Documentation Company & Prospect Profiling Internationalization (I18N) Testing
CMM Documentation Reporting Solutions
Assessment of Unmet Market Needs Records Management
Deployment and Support Status and Potential of Technologies
Document Management Solutions
Benchmarking of Strategies Vs
Competition Record Management Storage and
Installation and Configuration Guides
Retrieval
Operations Manual Forecasting
Sales Force Effectiveness
Market Assessments
Competitive Intelligence
Opinion Leadership
Emerging Markets - evaluation and
research
The Writers Block www.twb.in 5
8. TWB Software Tools Expertise
Our technical proficiency in software and authoring tools includes:
Unstructured Content XML Structured Editors Multimedia /Authoring
Development
Epic Adobe Flash®
Microsoft Word® FrameMaker+SGML Adobe Dreamweaver®
Adobe FrameMaker® X-Metal® Microsoft FrontPage®
Adobe InDesign® Adobe Captivate®
QuarkXPress® Macromedia Captivate
Adobe PageMaker® Graphics/Animations
Multimedia /Authoring /
Illustrations Adobe Flash® Supporting tools
Adobe Photoshop®
Adobe Flash CS4 Professional Adobe Fireworks® Adobe Flash®
Adobe Illustrator CS3 Adobe Flex®
CorelDRAW Online Help Adobe AIR®
Microsoft-Expression Graphic Adobe Dreamweaver®
Designer Adobe Acrobat®
Xara Xtreme (Windows & Linux) JavaHelp
Microsoft Silverlight®
CuteDraw Adobe RoboHelp 7.0
Adobe Authorware®
Publisher3D(for animation) HelpScribble
Adobe Director®
Sketsa SVG Editor (for vector WebWorks Publisher
Adobe Captivate®
graphics) PowerCHM
Trivantis Lectora®
Techsmith Camtasia Doc-To-Help
ASP.NET
Adobe Flash CS4 Professional WinCHM
JSP
Arbortext IsoDraw (technical HelpSmith 2.1.1(Windows)
JAVA
illustrations for 2D and 3D) Fast-Help
MadCap Flare Standards
Graphics/Animation Help-Server
NVU Help
SCORM 1.2 / 2004
Adobe Flash® AICC
XML
Adobe Photoshop® W3C
Adobe Illustrator® Section 508
Adobe Fireworks® XMetal® QTI XML
Microsoft Silverlight® Microsoft Word 2003®,
Microsoft Word 2007®
Databases Development and Publishing
tools
CMS/ LMS
Microsoft Access XSLT/XSL
Microsoft SQL Server EDD
Sharepoint®
Moodle
Flowcharting Joomla,
WordPress
Microsoft Visio Media Wiki
iGrafx CMS Builder
EDraw Author-it (formerly AuthorIT)
RFFlow Alfresco
Flowbreeze
Smart Draw
The Writers Block www.twb.in 6
9. Industries Served
TWB services a wide range of technology and knowledge driven industries, helping them meet their markets better, these include:
Banking, Insurance and Financial Services ITES/ KPO/ BPO
Consulting and Business Services Pharmaceuticals and Biotechnology
Defense, Aerospace and Hi-Tech Manufacturing Process Manufacturing and Allied Industries
Education and Learning Steel, Ship Building, Construction and Aviation
IT, ITES Telecom and Digital Communications
TWB has been the preferred technical documentation outsourcing company for:
The TWB Building US Office:
No: 4062, 19th Main Road, TWB
HAL 2nd Stage, 11701 Norwegian Wood Drive
Bangalore – 560008 Austin, TX 78758
India.
Landmark: Behind Carlton Towers
Telephone: Telephone:
+91.80.40741400 / +91.80.41256367 +1.512.586.8357
Corporate Enquiries: corp@twb.in
The Writers Block www.twb.in 7