July 26, Deworkacy - DocOps from Rostelecom
Hello!
We decided to hold a DocOps mitap here - it's almost like DevOps, only about the documentation and everything related to it. There are usually not many such events, it’s understandable - the documentation is not such a hype thing as React, for example. And not only React, frankly. Evil languages ​​generally claim that documentation spoils vision.
')
But it is really important, people work with it, and the more correctly and more logically in your company the processes of working with documentation are built, the easier it will be for everyone. Even to those colleagues whose work (at first glance) is not connected in the documentation.
In general, on Friday, July 26, at 19.00 we are going to Deworkacy (Moscow, Bersenevskaya Naberezhnaya, 6, p. 3) and we begin todocument and talk about documentation . The list of reports is under the cut.
19.00–19.30 Nikolay Potashnikov, Kurs-IT company
Maintaining documentation for the software product and its reuse in reporting to the customer
We have been using Asciidoctor for documentation in large custom projects for more than two years. During this time, a set of simple practices has accumulated, allowing both to speed up the work and improve the quality of documents received. In the report, I will consider solving several practical problems in preparing documentation in Asciidoctor, which we encounter in almost every project.
19.30–20.00 Lana Novikova, Iponweb company
How we tried to cross Sphinx and Confluence
The organization of a corporate wiki is often opposed to the Docs as code approach. I’ll tell you how we tried to reconcile them as part of a single approach, I’ll tell you about the experience of setting up the publication of artifacts of the knowledge base of the UI development team via CI in Confluence as a separate target, that we took into account in advance, did not take into account what we plan to do and what kind of “rake” we met on a way.
20.30–21.00 - coffee break, networking.
21.00–21.30 Nikolay Volynkin, Plesk company
Replacing rails under a traveling train
We change the documentation development tool to docs-as-code. Wherein:
21.30–22.00 Konstantin Valeev, Rostelecom Information Technologies
Maintaining documentation repositories
I’ll tell you how to maintain a repository with documentation, consider several standard approaches that you can borrow from development, and a couple of specific ones specifically for documentation.
22.30–23.00 free communication
And one more time for those who simultaneously read the announcement and continued to document.
We decided to hold a DocOps mitap here - it's almost like DevOps, only about the documentation and everything related to it. There are usually not many such events, it’s understandable - the documentation is not such a hype thing as React, for example. And not only React, frankly. Evil languages ​​generally claim that documentation spoils vision.
')
But it is really important, people work with it, and the more correctly and more logically in your company the processes of working with documentation are built, the easier it will be for everyone. Even to those colleagues whose work (at first glance) is not connected in the documentation.
In general, on Friday, July 26, at 19.00 we are going to Deworkacy (Moscow, Bersenevskaya Naberezhnaya, 6, p. 3) and we begin to
19.00–19.30 Nikolay Potashnikov, Kurs-IT companyMaintaining documentation for the software product and its reuse in reporting to the customer
We have been using Asciidoctor for documentation in large custom projects for more than two years. During this time, a set of simple practices has accumulated, allowing both to speed up the work and improve the quality of documents received. In the report, I will consider solving several practical problems in preparing documentation in Asciidoctor, which we encounter in almost every project.
19.30–20.00 Lana Novikova, Iponweb companyHow we tried to cross Sphinx and Confluence
The organization of a corporate wiki is often opposed to the Docs as code approach. I’ll tell you how we tried to reconcile them as part of a single approach, I’ll tell you about the experience of setting up the publication of artifacts of the knowledge base of the UI development team via CI in Confluence as a separate target, that we took into account in advance, did not take into account what we plan to do and what kind of “rake” we met on a way.
20.30–21.00 - coffee break, networking.
21.00–21.30 Nikolay Volynkin, Plesk companyReplacing rails under a traveling train
We change the documentation development tool to docs-as-code. Wherein:
- do not stop the development and publication,
- we make and compare prototypes on several tools,
- We transfer documentation translations,
- correct errors and align the style in the source content,
- do without manual work.
21.30–22.00 Konstantin Valeev, Rostelecom Information TechnologiesMaintaining documentation repositories
I’ll tell you how to maintain a repository with documentation, consider several standard approaches that you can borrow from development, and a couple of specific ones specifically for documentation.
22.30–23.00 free communication
And one more time for those who simultaneously read the announcement and continued to document.
- July 26, Friday
- Moscow, Bersenevskaya embankment, 6, p. 3 (Deworkacy, small lecture hall)
- 19.00–23.00
- The entrance is free.
- Link to registration.
Source: https://habr.com/ru/post/460899/
All Articles