Technical Documentation
TECHNICAL DOCUMENTATION
RAMSys Assurance Pty Ltd has a dedicated pool of 15+ technical writers with experience spanning 3 to 15 years. With extensive experience and knowledge of DDLC (Documentation Development Life Cycle) and SDLC (Systems development Life Cycle), these professionals do a meticulous study of users’ requirements and deliver concise and clear documents per audience, helping the company save costs incurred on customer support calls. They have worked at reputed global companies like Motorola, CA (Computer Associates), HP, CISCO, Honeywell, GE, Facetime, Symphony, and so on, and these professionals have in depth expertise in creating documents for:
- Aviation
- Tele Communication
- Networking
- Security
- Storage
- Industrial Appliances
User Documentation
- User’s Manual: To educate the user on using a product effectively.
- Online Help Systems: To assist users quickly locate the information they require while working with a product with context-sensitive and user-centric (restricted) help.
- Installation Guide: To install and get a product running ASAP.
- Reference Guide: To assist advanced users with typical references.
- Illustrative documents: To help users know a product at a glance (presentations and web demos of products) and decide on buying.
- Troubleshooting Guides: To help users troubleshoot the product and resume work without waiting for the support engineers.
- SOP-based documents for industrial devices and appliances.
- Administrative Manual: To help administrators maintain and keep the system up and running.
- Service Manual: To help support engineers fix product issues and minimize system downtimes.
- Installation & Configuration Manual: To educate deployment teams to install and configure complex systems.
- API documentation: To help software engineers use an API effectively without much support.
- Test Cases: To help verification engineers cover all test scenarios, test conditions, and expected results for a requirement.
- Training Manuals: computer-aided instructional, multimedia-integrated training packages.
Document Conversion
- MS Word/FrameMaker to XML (for Content Management System)
- MS Word to MS Help2/Java Help/ XML/CHM/HLP/WebHelp/PDF
- FrameMaker to MS Help2/Java Help/ XML/CHM/HLP/WebHelp/PDF
- PageMaker to MS Word, FrameMaker, XML
Tools
| Authoring | XML Authoring | Publishing | Imaging | CMS | Review | Version Control |
|---|---|---|---|---|---|---|
| Framemaker | Arbortext (Epic Editor) | ePublisherPro | Adobe Photoshop | Vasont | Final Draft | ClearCase |
| Madcap Flare | Xmetal | Adobe Acrobat | Adobe Illustrator | Author IT | Adobe Acrobat | ClearCase |
| MS Word | PaintShop Pro | Visual SourceSafe | ||||
| RoboHelp | SnagIT | StarTeam | ||||
| IrfanView | RoboHelp |