ChapsVision
Senior Freelance Technical Writer — Documentation from Scratch
Key Elements
| Category | Data |
|---|---|
| Organization | ChapsVision |
| Period | February to May 2022 |
| Domain | Data preparation, exploration, and analysis |
| Role | Freelance Senior Technical Writer |
| Scope | Documentation architecture, product exploration, writing, tutorials, and portal implementation |
| Audiences | Administrators, technical users, data specialists, and integrators |
| Language | French |
| Environment | Docusaurus, Markdown, Azure Repos, REST APIs, and low-code workflows |
Project Overview
ChapsVision develops data intelligence solutions for complex and highly secure environments.
During a four-month consulting assignment, I created the first documentation for ArgonOS, a platform for data preparation, exploration, and analysis. My work focused primarily on the Data Preparation module, while also covering installation, administration, selected API content, and essential platform concepts.
The project started without any existing documentation. I therefore had to understand the product directly through hands-on exploration, discussions with R&D, and progressive validation with subject-matter experts.
Context
ArgonOS was still evolving, and no structured documentation corpus was available when the assignment began.
The challenge was therefore not to migrate or revise existing content, but to identify what users needed to understand, formalize the product's concepts and workflows, and create a complete documentation structure within a limited timeframe.
Because the platform combined technical administration, data processing, low-code modules, and complex user workflows, the documentation had to support both conceptual understanding and practical adoption.
Key Deliverables
Documentation Architecture & Content Creation
I defined the documentation architecture and created the content directly from the product.
My approach combined:
- hands-on testing of the application;
- interviews and iterative reviews with R&D;
- identification of unclear behaviors and missing information;
- progressive validation of concepts, procedures, and terminology.
The resulting documentation covered installation, administration, configuration, platform usage, Data Preparation concepts, and selected API-related information.
I also created a catalogue of the application's low-code modules, providing a structured reference for their purpose, configuration, and use.
User Workflows & Documentation Portal
To help users move beyond individual features and understand how to use the platform in practice, I created detailed tutorials based on complete data-preparation workflows.
These tutorials combined procedures, screenshots, low-code processes, diagrams, and explanations of the expected results.
I proposed and implemented Docusaurus as the documentation platform, using Markdown and a docs-as-code approach. The portal included structured navigation, search, customized components, and a visual identity aligned with the product.
A standalone HTML installation guide was also produced for offline use.
The completed portal was very positively received by its first users and provided a structured foundation for the technical writers who later continued the documentation effort.
My Role
I managed the project from product discovery to publication, combining documentation architecture, technical writing, user workflow design, visual content creation, and documentation portal implementation.
The assignment relied heavily on my ability to learn an unfamiliar technical product quickly, turn implicit product knowledge into structured content, and work autonomously while maintaining close collaboration with R&D.
Technologies & Tools
Docusaurus, Markdown, Microsoft Azure Repos, Git, Sourcetree, Visual Studio Code, REST APIs, Redocusaurus, HTML, CSS, low-code workflows, and Excalidraw.
Confidentiality
The ArgonOS documentation portal and its technical content are confidential and cannot be displayed publicly.
This page therefore presents the scope, approach, and expertise involved without disclosing proprietary product information.
©Author: Florence Venisse, Technical Documentation & AI Expert – Reviewed version of 07/21/2026.