Navis Software India Private LtdProject Details
Project Name: Master Terminal User Release Notes 20.0.21.04
Role: Senior Technical Writer
Description
Documented the summary of changes for bug fixes in the table format in the respective columns, module, reference, and High-level change information.
Documented the Reason of Changes and Details of Changes for all the enhancements and new features under the respective modules.
Roles and Responsibilities
Responsible for gathering the information from TFS, coordinating with the Developer for any clarifications and independently documenting all the changes across the following modules:
Invoice
System Administration
Voyage Operations
Web Application
Yard Operation
Once completed, performed a self-review, sent the document for Technical review. Later, I incorporated the comments and published the final document.
Tools
Madcap Flare, TFS, and Snagit
Project Details
Project Name: Master Terminal User Release Notes 20.0.21.05
Role: Senior Technical Writer
Description
Documented the summary of changes in the table format in the respective columns, module, reference, and High-level change information.
Documented the permissions required to access some screens in the application.
Documented the Reason of Changes and Details of Changes for all the enhancements and new features under the respective modules.
Roles and Responsibilities
Responsible for gathering the information from TFS, coordinating with the Developer for clarifications and independently documenting all the changes across the following modules:
Cargo
Report
System Administration
Voyage
Web
Once completed, performed a self-review, sent the document for Technical review. Later, I incorporated the comments and published the final document.
Tools
Madcap Flare, TFS, and Snagit
Project Details
Project Name: Master Terminal User Guides 20.0.21.04
Role: Senior Technical Writer
Description
Documented the changes in the following modules:
Invoice
System Administration
Voyage Operations
Web Application
Yard Operation
Roles and Responsibilities
As an individual contributor, I documented all the changes specified in the User Release Notes in the User Guide.
I initially planned the sections where the changes have to be included and documented the various changes in the respective MTN user guides in more detail. I have included appropriate screenshots wherever possible to add clarity.
Tools
Madcap Flare, TFS, and Snagit
Project Details
Project Name: Master Terminal User Guides 20.0.21.05
Role: Senior Technical Writer (Individual Contributor)
Description
Documented the changes in the following modules:
Invoice
System Administration
Voyage Operations
Web Application
Yard Operation
Roles and Responsibilities
As an individual contributor, I documented all the changes specified in the User Release Notes in the User Guide.
I initially planned the sections where the changes have to be included and documented the various changes in the respective MTN user guides in more detail. I included the topics, subtopics, procedures, and appropriate screenshots wherever possible to add clarity.
Tools
Madcap Flare, TFS, and Snagit
Project Details
Project Name: Master Terminal User Guides 20.0.21.04
Role: Senior Technical Writer (Individual Contributor)
Description
Documented the changes in the following modules:
Invoice
System Administration
Voyage Operations
Web Application
Yard Operation
Roles and Responsibilities
As an individual contributor, I documented all the changes specified in the User Release Notes in the User Guide.
I initially planned the sections where the changes have to be included and documented the various changes in the respective MTN user guides in more detail. I included the topics, subtopics, procedures, and appropriate screenshots wherever possible to add clarity.
Tools
Madcap Flare, TFS, and Snagit
Project Details
Project Name: Master Terminal User Guides
Role: Senior Technical Writer (Individual Contributor)
Description
Replaced screenshots and modified the contents wherever required in all the user guides.
Roles and Responsibilities
During the process of doing a doc synchronization with the latest build, I updated the required screenshots in all the Master Terminal Guides.
Also, as and when I replaced the screenshots, I modified the contents of the user guides based on the updated screenshot.
This was a great effort. As the guides were really huge many screenshots to be replaced.
Tools
Madcap Flare, TFS, and Snagit
Project Details
Project Name: N4 APIs for WorkShift
Role: Senior Technical Writer
Description
This was a stand-alone document created from scratch. I created an API documentation for Work Shift. N4 allows you to record relevant details, such as Point of Work (POW), start time, end time, and duration for the work shift.
The following topics are covered in this document:
Creating a Work Shift
Updating Work Shifts
Viewing the Work Shifts
Deleting a Work Shift
Roles and Responsibilities
I documented various field names, variform names, and Descriptions, field Validations, and Exceptions.
I included the examples wherever possible to add clarity
Tools
Word, Confluence, and Adobe Acrobat
Project Details
Project Name: Cargo Move User Guide
Role: Senior Technical Writer
Description
Cargo Move is a mobile application. I documented this guide from scratch.
The main topics included in this guide were:
Configuring N4 Server Details
Signing In
Site Selection Screen
CHE Type Selection Screen
Available Cargo Screen
Claimed Jobs Screen
Drawer Menu
Roles and Responsibilities
I initially planned and outlined the structure of the document based on the topics and subtopics in the guide. Also included the required procedures, appropriate screenshots, and validations wherever possible to add clarity.
Tools
Word, JIRA, Confluence, Author-it, and Adobe Acrobat
Project Details
Project Name: Cargo User Guide (Different versions)
Role: Senior Technical Writer
Description Documented the following changes:
Cargo Settings
Cargo Lots view
o Load Plan
o Discharge Plan
o Cargo Move form
o Cargo Load form
Cargo Allocation Range view
Storage Handling Code view
Equipment Handling Code view
N4 Mobile Cargo
o Vessel Load
o Vessel Unload
o Move Cargo
Cargo How Do I topics
Roles and Responsibilities
As an individual contributor, I documented all the changes specified in the User Release Notes in the User Guide.
I initially planned the sections where the changes have to be included and documented the various changes in the Cargo User Guide in more detail. I included the topics, subtopics, procedures, and appropriate screenshots wherever possible to add clarity.
Tools
MS-Office, Author-It, JIRA, Confluence, Adobe Acrobat, Salesforce, and Snagit
Project Details
Project Name: EDI Billing and Services Guide (Different versions)
Role: Senior Technical Writer
Description Documented the following changes:
EDI Message Settings
Troubleshooting EDI topics
EDI Errors view
EDI Mapping
o Prerequisites
o Mounting Files
o Source
o Target
o Transforming the EDIFACT Message to XML and Mapping Elements
o Mapping Checklist
o Functions
EDI How Do I
o Create an EDI mapping file using the CSV file in N4
o EDI Message Specifications
Billing Settings
Billing Troubleshooting topics
Roles and Responsibilities
As an individual contributor, I documented all the changes specified in the User Release Notes in the User Guide.
I initially planned the sections where the changes have to be included and documented the various changes in the respective EDI Billing and Services Guide in more detail. I included the topics, subtopics, procedures, and appropriate screenshots wherever possible to add clarity.
Tools
MS-Office, Author-It, Adobe Acrobat, JIRA, and Snagit
Project Details
Project Name: Inventory Management (Different versions)
Role: Senior Technical Writer
Description
Documented the following changes:
Inventory Settings
Unit Privileges
N4 Mobile Inventory settings
Troubleshooting Inventory Issues topics
Troubleshooting Reefer topics
Equipment Orders Management
o Equipment Delivery Order view
o Import Delivery Order view
Roles and Responsibilities
As an individual contributor, I documented all the changes specified in the User Release Notes in the User Guide.
I initially planned the sections where the changes have to be included and documented the various changes in the respective Inventory Management User Guide in more detail. I included the topics, subtopics, procedures, and appropriate screenshots wherever possible to add clarity.
Tools
MS-Office, Author-It, Adobe Acrobat, JIRA, Salesforce, and Snagit
Scientific Games India Private Limited
At Scientific Games, apart from the below guide, I was working on a documentation for a product know as iVIEW, which was a highly technical product.
Project Details
Project Name: User Release Notes for Technical Services Team(Different versions)
Role: Lead Technical Writer
Description
Documented User Release Notes
Roles and Responsibilities
I was an individual contributor and documented the User Release Notes for Technical Services. The Technical Services team were in close contact with the customers and tried to address their issues on high priority. There were frequent releases. I worked on the bug fixes, new features, and enhancements.
Tools
Adobe Framemaker and Adobe Acrobat
Project Details
Project Name: User Guides for SDS Team
Role: Lead Technical Writer
Description
I worked on various modules, such as Asset Management User Guide which was part of the Slot Data System (SDS). This was one of the most significant team in my organization for which I was taking care of the documentation.
Roles and Responsibilities
I was part of the SDS team, but I was assigned few guides.
I included the main topics, sub-topics, and procedures along with screenshots.
Also, there was integrated help feature for which we were using the Robohelp software. I had to update the changes in Robohelp also in addition to Framemaker.
Tools
Adobe Framemaker, Robohelp, RoboSource Capture, MS-Office, HTML, and Adobe Acrobat
Project Details
Project Name: User Guides for CMS (Casino Management System) Team
Role: Lead Technical Writer
Description
I worked on various modules, such as Player User Guide which was part of CMS..
Roles and Responsibilities
I was part of the CMS team and I was assigned few guides.
I included the main topics, sub-topics, and procedures along with screenshots.
Also, there was integrated help feature for which we were using the Robohelp software. I had to update the changes in Robohelp also in addition to Framemaker.
Tools
Framemaker, Robohelp, RoboSource Capture, MS-Office, HTML, and Adobe Acrobat
Elixir Technology Private Ltd
Project Details
Project Name: Elixir Ensemble User Guide
Role: Technical Writer
Description
Elixir Ensemble was a software which was developed and maintained by Elixir Technology and was used in data extraction and manipulation.
Roles and Responsibilities
This was a contract job and I was the sole writer hired to complete the documentation of the software application within 6 months timeframe.
Tools
XMLMind XMLEditor
Bitech International Pvt Ltd
Project Details
Project Name: Hospital Maintenace User Guide
Role: Technical Writer
Description
The Hospital Maintenance project was developed to maintain details of the hospital and the patients.
Roles and Responsibilities
This was a contract job and I was the sole writer hired to complete the documentation of the Hospital Maintenance Software within 6 months timeframe.
Tools
MS-Word, Paint shop pro
ProtechSoft Asia-Pacific Pte Ltd
Project Details
Project Name: Handbooks and Transparencies for various software
Role: Content Writer
Description
SSI was into training students on the various software applications.
Roles and Responsibilities
As content writers, I prepared contents for the software books used by the students. Also, we prepared transparencies and help pages for the faculties who were training the students.
Also, I worked on CitiDirect which was a project developed for Internet Home Banking system. This allows the customers of CitiDirect to perform banking transactions online. The integrated audio explains the functionality of CitiDirect to the users.
Tools
MS-Office Tools, PowerPoint, JavaScript, HTML, and DHTML
SSI Software Ltd
Project Details
Project Name: MOLD User Guide
Role: Technical Writer
Description
MOLD was an Autocad Engineering design software for automobiles. I had to do web designing and documentation for the online help.
Roles and Responsibilities
This was a contract job and I was the sole writer hired to complete the documentation of the Mold Software within the stipulated target time. Also, I prepared tool tips which was integrated as part of the help feature.
Tools
HTML Help WorkShop, JavaScript, Winhelp, Paint shop pro, Animation Shop and Adobe acrobat
.
Home
| Freelanceindia
| Sitemap
| About
us | Answers
| Resources | Testimonials
1-Nov-2022
