Skip to main content

2025-07-24 User Documentation Process

· One min read

Presenter: Shoba Rao Moderator: Daniela De Vincenzi

The demo explains the essentials of a user documentation process covering definition, key artifacts (like documentation plans, templates, checklists, audit/version control, localization and accessibility guidelines, troubleshooting sections) and why each is critical for consistency, compliance and user experience.

video link

2025-05-22 Document structure for product development

· 2 min read

Presenter: Catherine-HongJuan Fang, Christer Wibom Moderator: Daniela De Vincenzi

The demo shows a proposed folder structure for managing product and project documentation within OnePCP DMS, aiming to address past issues with scattered and hard-to-locate files. It introduces a unified approach that includes hardware, software, and cybersecurity documentation throughout the development lifecycle. The structure is currently to be created manually, as automation is planned after the summer. While mandatory for new products, existing projects may continue using their current structures unless a migration is deemed beneficial.

video link

How to manage queries automatically

Project Cockpit

2025-05-08 Pull request documentation template

· One min read

Presenter: Nicolas Martin-Vivaldi, Moderator: Daniela De Vincenzi

The demo introduces a new pull request template aimed at formalizing the review process for Markdown documentation files, particularly those related to product and Quality Management System (QMS) content. Examples in Azure DevOps are presented, showing the use of the template within Git repositories.

video link