#подготовка_документации — Public Fediverse posts

«Боргворглер: боргает ворглер», или как сделать действительно полезную документацию к проекту

Обсуждения неудачных примеров README-файлов и документации — одна из популярных тем на профильных площадках и форумах [вкупе с другими «вечнозелеными» спорами в ИТ]. Мы в

https://habr.com/ru/companies/beeline_cloud/articles/1036004/

#beeline_cloud #документация #readme #подготовка_документации #документирование_кода

Разбор реализации docs-as-code на базе Sphinx

Привет, Хабр! Меня зовут Артём Зеленкин, приятно познакомиться! Я работаю техническим писателем около 20 лет, сейчас занимаюсь документированием в подразделении ARMA компании Infowatch . Для создания и поддержки актуальности документации по продуктам линейки ARMA мы используем docs-as-code. Что из этого получается, можно посмотреть на сайте с документацией (там же можно скачать pdf-версию, чтобы сравнить, как оно выглядит в разных форматах при тех же исходных данных). В данной статье я не пытаюсь рассказать, что такое docs-as-code (думаю, статей по теме достаточно), а рассказываю, как этот принцип реализован у нас. Может, вам тоже пригодится.

https://habr.com/ru/companies/infowatch/articles/1033072/

#документация #технический_писатель #техпис #подготовка_документации #infowatch #ARMA

Разбор реализации docs-as-code на базе Sphinx

Привет, Хабр! Меня зовут Артём Зеленкин, приятно познакомиться! Я работаю техническим писателем около 20 лет, сейчас занимаюсь документированием в подразделении ARMA компании Infowatch . Для создания и поддержки актуальности документации по продуктам линейки ARMA мы используем docs-as-code. Что из этого получается, можно посмотреть на сайте с документацией (там же можно скачать pdf-версию, чтобы сравнить, как оно выглядит в разных форматах при тех же исходных данных). В данной статье я не пытаюсь рассказать, что такое docs-as-code (думаю, статей по теме достаточно), а рассказываю, как этот принцип реализован у нас. Может, вам тоже пригодится.

https://habr.com/ru/companies/infowatch/articles/1033072/

#документация #технический_писатель #техпис #подготовка_документации #infowatch #ARMA

Разбор реализации docs-as-code на базе Sphinx

Привет, Хабр! Меня зовут Артём Зеленкин, приятно познакомиться! Я работаю техническим писателем около 20 лет, сейчас занимаюсь документированием в подразделении ARMA компании Infowatch . Для создания и поддержки актуальности документации по продуктам линейки ARMA мы используем docs-as-code. Что из этого получается, можно посмотреть на сайте с документацией (там же можно скачать pdf-версию, чтобы сравнить, как оно выглядит в разных форматах при тех же исходных данных). В данной статье я не пытаюсь рассказать, что такое docs-as-code (думаю, статей по теме достаточно), а рассказываю, как этот принцип реализован у нас. Может, вам тоже пригодится.

https://habr.com/ru/companies/infowatch/articles/1033072/

#документация #технический_писатель #техпис #подготовка_документации #infowatch #ARMA

Разбор реализации docs-as-code на базе Sphinx

Привет, Хабр! Меня зовут Артём Зеленкин, приятно познакомиться! Я работаю техническим писателем около 20 лет, сейчас занимаюсь документированием в подразделении ARMA компании Infowatch . Для создания и поддержки актуальности документации по продуктам линейки ARMA мы используем docs-as-code. Что из этого получается, можно посмотреть на сайте с документацией (там же можно скачать pdf-версию, чтобы сравнить, как оно выглядит в разных форматах при тех же исходных данных). В данной статье я не пытаюсь рассказать, что такое docs-as-code (думаю, статей по теме достаточно), а рассказываю, как этот принцип реализован у нас. Может, вам тоже пригодится.

https://habr.com/ru/companies/infowatch/articles/1033072/

#документация #технический_писатель #техпис #подготовка_документации #infowatch #ARMA

[В закладки] Гайд по составлению ТЗ для внутреннего пентеста

С виду все просто: дали пентестерам доступ в сеть, они пошарились по серверам, нашли пару уязвимостей, написали отчет. Профит. Но на деле плохо подготовленная проверка легко превращается в хаотичный квест с непредсказуемым финалом. В лучшем случае вы получите бесполезный список из сотни мелких «дыр» в принтерах и кофемашинах. В худшем — пентестеры случайно обрушат производственную линию или устроят DDoS на Active Directory. А между этими крайностями лежит целый спектр проблем: от юридических рисков, если в документе не очертить скоуп и команда выйдет за рамки дозволенного, до банального несовпадения ожиданий и результатов. Однако всех этих неприятностей легко избежать, если подойти к планированию внутреннего пентеста основательно. В этой статье разберем, почему техническое задание — не формальность, а жизненно важный документ, и покажем, как его правильно составить. Кто-то возразит, что это утопия, и в реальности все работают иначе, но нам бы хотелось это изменить. Поверьте: оно того стоит.

https://habr.com/ru/companies/bastion/articles/938586/

#пентест #техническое_задание #техзадание_для_пентеста #как_составить_тз_для_пентеста #тестирование_на_проникновение #методология_пентестов #как_организовать_пентест #отчетность_по_пентесту #подготовка_документации #разработка_тз

Передаем документацию заказчику: Markdown, Git, CI/CD и почти полная автоматизация

Представьте, что вы разработали программное обеспечение. Все идеально: код отточен, тесты пройдены, система готова к работе. Но тут встает вопрос: как отправить документацию заказчику? Всем привет! Меня зовут Катя, я развиваю Рассказывай!

https://habr.com/ru/companies/gram_ax/articles/920350/

#заказная_разработка #подготовка_документации #автоматизация_бизнеспроцессов

Как создать хороший FAQ

Привет, Хабр! Я Евгения Береснева, технический писатель в X5 Tech, и я считаю, что классный раздел вопрос-ответов нужен любому продукту. В статье как раз расскажу о том, как его создать.

https://habr.com/ru/companies/X5Tech/articles/803563/

#faq #вопросответ #документация #техническая_документация #вопросы_пользователей #подготовка_документации #гайд #как_писать #как_писать_документацию