(+39) 335 707 8284 [email protected]

Software documentation in a Scrum environment

by

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.

Discover our services

We can offer you consultancy, training, digitalisation…

Do you need more information?

Briefly describe your needs, we will respond shortly with the most suitable solution or service.

Experience the Power of AI: A Practical Guide to Implementing a Successful Business Chatbot

Introduction Adopting a business chatbot that can provide fast, multilingual access to technical documentation through a conversational interface is an innovative strategy. This approach optimizes operational efficiency and improves information management within the...

Modular Content in Business Communication

Modular content is an innovative strategy for content management and creation. It consists of breaking down complex content into reusable modules that can be combined to create effective and engaging customer experiences. These modules, like building blocks, provide efficiency, flexibility, customization, and SEO optimization where needed.

Multi-language Virtual Assistant

Innovation for your business: Multilingual Virtual Assistant Find out how you can simplify access to information and improve support for your customers with our multilingual virtual assistant. Why Choose Our Virtual Assistant? Gets instant access to the information in...

Business growth strategy with high-quality technical content

A recent report details nearly 100 million user sessions in 136 countries, providing a comprehensive picture of user behavior around technical content. The results underscore the critical importance of delivering high-quality, well-structured content to capture interest, support customers and employees, and drive efficient and automated usage that results in significant operational savings.

Chatbot for accessing company documentation

Wouldn't you like to have a virtual assistant that can instantly locate a piece of documentation data by asking a simple question, even verbally? For example, to solve urgent problems or find information about products or services scattered in multiple documents. And...

Cybersecurity Guides

Today, it is essential to have a cybersecurity strategy and proper documentation. In this situation, having professional expertise is beneficial for creating new documents using robust, tested templates and for understanding how to utilize the right tools to manage all the sensitive technical information effectively.

Writing a style guide

Style guides give you the ability to present your brand or product in a polished and consistent manner. They save time by providing immediate answers to recurring doubts and questions, and are a necessary reference for new employee training.

Online Help for Software applications

The Online Help system is the user guide that is instantly available for user assistance. The software application looks serious and trustworthy, builds trust, gives users full autonomy, and reduces support calls.

API documentation

Investing in API documentation allows vendors to provide the best experience for customers who demand ease of use and therefore complete and accurate documentation. Click here to learn more about how a technical writer can make a difference.

Structured documentation with CCMS

Modern tools for developing documentation exist to ensure an optimized and structured approach, resulting in improved quality and reduced costs. What are they? Find out here.

Writing to communicate value

How to write well to reduce support requests, complaints, risk of damage, and malfunctions? And to be able to improve image and reduce the costs of training and supporting?

Operation and Maintenance Manuals

What should be included in a good operating and maintaining manual? How should it be structured to ensure that its goals are adequately addressed? Did you know that there is an international standard to which you should refer?

Avvia chat
Ciao 👋
Come possiamo aiutarti?