Back to top
RU

Writing

Technical documentation: user guides, architecture documents, instructions, API references

Where I wrote documentation

What I write

Documentation for software products and hardware. For developers, users and partners, in Russian and English.

  • User guides and instructions.
  • Architecture documents and API references.
  • Onboarding materials for employees and customers.
  • Documentation style guides: terminology, structure, formatting.
  • Document sets for registering software in the Russian software registry (ERRP).
  • Interface text (UX writing).
  • Translation of technical documentation from Russian into English and back.

Case studies

Documentation from scratch for the Mapius platform

T1 Holding, Innotech · 2024–2026 · technical writer

Task
Create technical documentation from scratch for Mapius, an API management platform from T1 Innotech. The platform is deployed on-premise, that is, in the customer’s infrastructure. The platform announcement on the T1 site.
What I did
  • Wrote the platform documentation.
  • Prepared a documentation package for commercializing the platform, including presentations and onboarding materials.
  • Developed the set of documents for registering the product in the ERRP registry.
Result
The platform now has complete documentation, go-to-market materials and a set of documents for the registry.

Documentation portals that teams launch on their own

T1 Holding, Innotech · 2024–2026 · technical writer

Task
Let development teams maintain and publish documentation themselves.
What I did
  • Introduced a knowledge management system in the Docs as Code approach on GitLab CI, Docker and Kubernetes.
  • Built and standardized documentation processes in an Agile environment and embedded them in the development teams' work cycles.
  • Co-authored a tool for automatically deploying Docs as Code projects.
Result
Teams launch documentation portals on their own, without DevOps engineers or technical writers.

AI agent for user support

Baikal Electronics · 2023 · technical writer

Task
Answer user requests based on the company's internal documentation.
What I did
Developed an AI agent for support. It analyzes user requests and generates answers from the company's internal documents.
Result
The agent handles 60% of requests without staff involvement.

Documentation for Baikal-T, Baikal-M and Baikal-S processors

Baikal Electronics · 2022–2024 · technical writer

Task
Document the hardware and software side of the processors and make the documentation available to international partners.
What I did
  • Developed documentation for the hardware and software side of the processors.
  • Translated it from Russian into English for international partners.
  • Introduced a knowledge management system in the Docs as Code approach.
  • Regularly took part in documentation peer reviews.
  • Created a set of 50+ components for formatting diagrams and schematics.
Result
Launched an SDK documentation portal built on the Docs as Code approach: sdkdocs.baikalelectronics.ru. The site and its content belong to Baikal Electronics. I have not maintained them since I left in 2024, so they may now differ from what I built.

Docs as Code for an external customer’s documentation

T1 Holding, Innotech · 2024–2026 · technical writer

Task
Support documentation for external customers: build new documentation from the customer’s documentation and other sources and maintain it following Docs as Code rules.
What I did
  • Described how to handle versions: the customer’s documentation and ours have their own branches, and each customer has one.
  • Worked out how to carry changes from the customer’s versions into our documentation, and proposed an intermediate layer (middleware) that turns the customer’s document into Markdown sources.
  • Planned the publishing channels: PDF, a website and a website on the customer’s side.
  • Told the commercial team about the new process and showed the tool in a demo.
  • Launched a pilot on VS Code, GitLab, T1 Cloud and Diplodoc.
Result
The pilot is running. From one set of sources the documentation is published as PDF and on a website.

How I work

Documentation lives next to the code, so it changes together with the product.

  • I write in Markdown and AsciiDoc and keep it in Git.
  • Colleagues review the texts in peer review.
  • GitLab CI or Jenkins build and publish the portal; Docker and Kubernetes run it.
  • The processes are built into the work cycles of Agile teams.
  • I work with engineers, team leads, managers and product owners, and with information security and sales specialists.

Before and after

A made-up example: an error message, the original and my version. You can switch the view.

What changed:

  • Instead of a code, it says what exactly went wrong.
  • The cause is named in plain words.
  • It is clear what to do next.

Real work: the Baikal Electronics SDK documentation portal. The site and its content belong to the company; I no longer maintain them.

Error 0x80070005: access denied.Could not save the file “Report.docx”: you do not have permission to write to this folder. Contact your administrator.Save the file to “Documents” or ask your administrator to grant access.

Tools

Writing and translation
Markdown, AsciiDoc, Confluence, MS Office. UX writing, technical translation.
Build and publishing
Git, GitLab CI, Jenkins, Docker, Kubernetes, static site generators (SSG), Linux, VS Code.
API and code
API, Postman, Python, HTML, CSS, JavaScript.
Diagrams and design
Figma, Draw.io, UML.
Processes
Agile, Jira, peer review, technical specifications.

Contacts