Project: Content development for online help for software applications in an agile / scrum environment
Customer: Siemens spa
Industry: Production of building management and control systems
Date: 2012-today
Description:
The project, which is still in progress, requires the development of an on-line help system for the software modules developed in Italy and other locations of a large supervisory and control system. As we have presented in this article, software documentation in the Agile/Scrum environment involves integrating documentation material with the software according to a regular schedule and frequent verification deliveries. Content includes descriptive, procedural, and reference text, as well as graphic illustrations and video animations.
Goals:
- Writing user documentation in English (on CCMS systems, specifically Quanos ST4) according to a Scrum process with regular deliverables aligned with software development.
- Publication and regular integration of HTML5 online help for Windows applications with contextual access to the software’s features and functions.
- Assisting the development team with usability testing of the user interface, with particular attention to consistency and effectiveness of text (labels, tooltips, error conditions).
- Active collaboration with Italian and foreign development teams.
- Creation of specialized documents, including – Cybersecurity guides and User interface Style guides.
Methodology:
Working with the development and test group according to the predefined process to gather the necessary technical information. Apply the latest editorial standards (see User and Maintenance Manuals) and operational best practices (see Writing to Communicate Value) using tools such as Quanos ST4. Applying corporate style guides.
Achievements:
We deliver documentation forms on time in accordance with agreed specifications. We constantly track and improve user satisfaction through the tools of distribution portals, which provide comments and ideas for improvement.
Specific skills and achievements:
Technical Expertise: Our team demonstrated the ability to acquire technical knowledge of the applications and prepare text, graphics, and video materials on time. Professionalism and Collaboration: Our team is professional and collaborative, willing to respond to requests and make changes as needed in the software development process. Clear and concise information: Technical information is presented clearly and concisely, organized in a logical and understandable manner according to established corporate standards. Ease of understanding: The material is always structured so that it can be easily used by the recipients, according to their level of knowledge and needs.
Conclusion:
Flowoza has experience and ability to provide quality services in writing online help according to the current agile development process. If these skills are of interest to you, please contact us for further study.
