SimplyTechnical provides a variety of Technical Writing Services. Services are provided for new documentation, document updates, and overflow work.
Template Design
Templates are created for single-sourcing and usability. All FrameMaker templates are prepared for easy export to PDF and HTML (help systems).
Research
Research services are provided as a basis for writing documentation or to provide you with what you need to write technical notes and white papers. Research can be technical research or market research to evaluate your desired documentation set. Interviewing engineers is key to good documentation. SimplyTechnical has years of experience in extracting information from engineering minds and translating it so that technical or lay users clearly understand it.
Document Types
Technical writing is provided for:
End-User Documentation- Service Documentation
- User's Manuals
- Operator Manuals
- Configuration Guides
- Reference Guides
- Installation Manuals
- Maintenance Manuals
- On-line Help Systems
- Programming Manuals
- Software Developer Kits(SDK)
- API Guides
- White Papers
- Internal Documents
- Engineering Process Documentation
- Training Material (online, presentations)
- Tutorials
- Web Content
Standards and Specs
SimplyTechnical has significant experience developing in accordance with specifications and standards. Here are few key items for which documents have been written:
- FDA
- 508 Compliance
- Military
- ISO
- FCC
- CE Mark
- IEC
- Blue Angel
- Energy Star
- Common Criteria
Development Methodologies
Each company develops in its own way. SimplyTechnical easily and quickly adapts to each development environment. Here are just a few of the most common environments in which we are comfortable:
- Agile
- SDLC
- PMI
- CMMI
- Rapid prototyping
- Waterfall
- SAFe
- Kanban
- test
- test
Industries
SimplyTechnical has experience in the following Industries:
- Telecom
- Healthcare
- Networking
- IDS/IPS
- Network Security
- Wireless
- Hardware
- Software
- Government
- Other
Editing/Review
Technical editing and review is provided for your existing documents. SimplytTechnical applies standard technical editing techniques and reviews for technical accuracy as well as consistency.
Production
Documents can be produced for press, PDF, and HTML. Translation services are also provided. Document source is delivered to all clients.
GUI Review
Technical Writers have deep insight into the way users operate GUIs. SimplyTechnical will review your GUI and provide comments on usability and consistency.
-
Debbi is a highly professional technical writer that is a joy to work with. Her amazing communication and coordination skills have been invaluable in collaborating with a varied team of cross-functional members to develop accurate and effective documentation for the varying audiences of our user groups.
-
Debbi is a top-notch technical writer who is clearly a master of her craft. She brings a level of "been there, done that" that would be of comfort to anyone releasing technical documents for a new product or service in the tech industry. Debbi is able to put together accurate timelines for delivery, communicates and collaborates well with all stakeholders and contributors throughout the project. Most importantly, Debbi is skilled at combining an understanding of the underlying technology of the product she is documenting with a good business-level understanding of her clients' needs to deliver quality publications that meet expectations. I would happily recommend Debbi's services and would certainly hire her for future documentation projects.
-
Ms. Leipold’s Technical documentation expertise proved extremely valuable to these projects. Ms. Leipold should be commended for her highly professional work and extensive time and effort expended towards providing critical documentation. Her conscientious attitude and thorough and efficient manner in which she accomplished documentation contributed significantly to the projects. We are especially appreciative of her dedicated support.
-
While working for network communication startup provided exceptional company-wide support from documentation tasks to GUI usability reviews. Debbi worked intensely to produce documentation quickly and to be an integral part of the team startup culture.
-
As a technical writer assigned to project X, Debbi produced several highly technical documents while working in a challenging environment. Debbi successfully coordinated with a wide range of developers, operators, system administrators, maintainers, and managers to create informative and comprehensive documentation for operational systems.
-
Debbi’s expertise as content developer and technical writer has been invaluable to the company. Faced with a multi-manual per platform, CD based QT movies, and limited tutorial solution, she quickly brought together, consolidated and simplified our support materials into a single, direct, user friendly support product. She was energetic, engaging, and the ever devoted mom. She was a persistent and wonderful flag-waving, get your attention to see a possible problem hands-on manager.
-
Debbi is extremely technical. She spend a significant amount of time researching and interviewing SMEs an clearly understands the products. She got up-to-speed quickly and with little, if any, assistance. Debbi produces accurate, high quality documentation while meeting tight deadlines in an ever evolving development environment.