Large documentation project for a building management station (2010-2020)

Pietro Margutti
Published

0
  • Project creator

Description
Development of an online help system for software modules produced by international teams within a large supervisory and control platform.
In an Agile/Scrum environment, documentation was created and maintained in parallel with software development, combining conceptual, procedural, and reference content supported by graphics and video.

Scope & Contribution

  • Authoring user documentation in English using Quanos ST4 (CCMS), aligned with Scrum iterations
  • Publishing and integrating contextual HTML5 online help for Windows applications
  • Contributing to UI usability through review and refinement of labels, tooltips, and error messages
  • Supporting interface consistency and clarity as part of the UX improvement process
  • Producing multiple PDF-based technical manuals and sales-support documents
  • Creating specialized materials including cybersecurity guides and UI style guidance
  • Collaborating with distributed development teams

Outcome
Documentation was delivered in sync with software releases and structured to improve usability, clarity, and consistency — supporting both end users and internal stakeholders across technical and commercial functions.