Documentation
The documentation process at TINC is a collaborative effort that involves multiple teams and roles. The Documentation team plays a crucial role in ensuring that the product documentation is accurate, comprehensive, and user-friendly.
To ensure collaborative and efficient documentation creation, we use Docs as Code practices. This approach allows us to manage documentation in a way that is similar to software development, using version control systems, continuous integration, and other tools to streamline the process.
The core activity of the Documentation team is to create and maintain product documentation. This includes reference manuals (user guides), technical guides, and other relevant materials that help users understand and effectively use our products.
The core activity of the Documentation team includes but is not limited to:
-
Reviewing the FogBugz case to identify documentation requirements based on input from Product Owners, Product Experts (testers), Developers, and other stakeholders (see roles).
-
Creating and maintaining source documentation in the respective GitHub repositories for each product (see Documentation Index).
For an overview of the complete documentation process, refer to the workflow summary (see Workflow). -
Translating the source documentation into target languages (see Translation). With each new version, differences from the previous version must be identified and translated accordingly. This ensures that the documentation remains up-to-date and accurate across all languages.
-
Create customer specific themes for the documentation (see Flavorization). This involves customizing the appearance and layout of the documentation to align with the branding and preferences of specific customers. This may include applying custom styles, colors, and logos to create a unique and personalized documentation experience for each customer.
Documentation Index
The following sections provide an overview of the documentation produced at TINC, including product manuals, SDK documentation, and knowledge bases. Each section includes links to the respective AsciiDoc repositories, HTML repositories, and rendered sites for easy access to the documentation resources.
Product manuals (Source documentation)
| Product | AsciiDoc repository | HTML repository | Render site |
|---|---|---|---|
Flux |
|||
Pix |
|||
Praxis |
|||
RA |
|||
RAOEM |
|||
Vulcan |
|||
VulcanOEM |
| Product | AsciiDoc repository | HTML repository | Render site | Available languages[1] |
|---|---|---|---|---|
TecZone (Flavorized from Flux) |
NA |
CS, DA, DE, ES, FI, FR, GR, HU, ID, IT, JA, KO, NL, PL, PTBr, RU, SK, SV, TH, TR, ZHS, ZHT |
||
L99 maintenance manual |
DE, CN |
|||
TecZone Cut reference manual |
DE |
| Product | AsciiDoc repository | HTML repository | Render site | Available languages[1] |
|---|---|---|---|---|
TJSCut-90 (Flavorized from Vulcan) |
DE, ES, FR, HU, IT, ZH |
|||
JFY Plus (Flavorized from Praxis) |
DE, ES, FR, HU, IT, ZH |
SDK Documentation / Knowledge bases
| Description | AsciiDoc repository | HTML repository | Render site |
|---|---|---|---|
Flux SDK documentation |
|||
Praxis SDK documentation |
|||
Developer Documentation |
|||
Academy'23 lectures |