Мы в социальных сетях
Мы в социальных сетях
Константин Нежберт
Технический писатель @ АО «Флант»
Санкт-Петербург

Орфография в контейнере: CI/CD для проверки документации

Описание:

Часто над документацией работают не только технические писатели, но и инженеры из разных команд, поэтому на начальном этапе многие термины, относящиеся, например, к Kubernetes, пишутся по-разному: кто-то использует сленг, кто-то — латиницу, а кто-то — кириллицу. Конечно, затем черновик документации попадает к техническому писателю и корректору, которые приведут его в надлежащий вид, но всё это занимает дополнительное время. Да и человек, пусть даже и специально обученный, может допустить ошибку или просто что-то пропустить.

Чтобы навести порядок в терминологии, а заодно и исправлять опечатки «на подлёте», мы решили создать специальный спелл-чекер и с его помощью автоматизировать проверку орфографии.

Ждем ваш отзыв

О спикере

Константин Нежберт
Технический писатель @ АО «Флант»
Санкт-Петербург

Константин Нежберт. Технический писатель со стажем 4 года. Open Source-энтузиаст и пользователь Linux в качестве основной ОС на протяжении 20+ лет. Занимался разработкой серверного ПО и ранее конструкторской деятельностью — разрабатывал аппаратные комплексы и документацию на них для нужд Министерства обороны, РЖД и метро. Имеет опыт разработки ПО для микроконтроллеров. В документации стремится к перфекционизму в оформлении, к лаконичности и смысловой ёмкости текстов. Последние 4 года занимается разработкой документации для Open Source-продуктов компании «Флант» и написанием технических статей на тематику Kubernetes.

Похожие доклады