#технический_писатель — Public Fediverse posts

Разбор реализации 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

Зачем айтишнику писать книги, и почему сейчас — самый лучший момент?

Привет, Хабр, на связи @holmogorov , руководитель проектов редакции компьютерной литературы издательства « БХВ ». Когда 25 лет назад, в 2001 году, в издательстве «Питер» вышла моя первая техническая книга, я и не думал строить карьеру в этом бизнесе. Можно сказать, я вообще попал в книжную сферу случайно: на тот момент я трудился в периодике, редактировал статьи для журнала «Магия ПК», а в свободное время делал сайты (кто тогда этим не занимался?). Однажды главред «Магии» Саша Альбов предложил мне халтуру: нужно было помочь коллегам из «Питера» отредактировать книжку по веб-дизайну, благо, я в этой области как раз неплохо разбирался. Однако ознакомившись с рукописью, я быстро понял, почему с проекта сбежал предыдущий редактор: текст был абсолютно безграмотен как с литературной, так и с технической точки зрения. «Это г… гениальное произведение нужно переписывать полностью», — заявил я тогда руководителю редакции Кате Строгановой, — «даже я написал бы такую книжку лучше». «Можешь — напиши!», — лаконично ответила Катя. И я написал. Потом еще и еще. Как в том анекдоте про кота и пылесос: сначала было страшновато, но со временем втянулся. Мир за прошедшие 25 лет изменился до неузнаваемости: тиражи упали примерно в пять раз, книжки подорожали почти на столько же, да и технологии в IT стали совсем другими. Я за это время написал и выпустил более 50 книг и сам стал руководителем направления в книжном издательстве. Но я считаю, что именно сегодня — самый лучший момент, чтобы сделать быструю и успешную карьеру в качестве писателя, а конкретно — автора компьютерной литературы. Причем сейчас для этого потребуется гораздо меньше усилий, чем 25 лет назад. И вот почему

https://habr.com/ru/companies/bhv_publishing/articles/1026664/

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

Зачем айтишнику писать книги, и почему сейчас — самый лучший момент?

Привет, Хабр, на связи @holmogorov , руководитель проектов редакции компьютерной литературы издательства « БХВ ». Когда 25 лет назад, в 2001 году, в издательстве «Питер» вышла моя первая техническая книга, я и не думал строить карьеру в этом бизнесе. Можно сказать, я вообще попал в книжную сферу случайно: на тот момент я трудился в периодике, редактировал статьи для журнала «Магия ПК», а в свободное время делал сайты (кто тогда этим не занимался?). Однажды главред «Магии» Саша Альбов предложил мне халтуру: нужно было помочь коллегам из «Питера» отредактировать книжку по веб-дизайну, благо, я в этой области как раз неплохо разбирался. Однако ознакомившись с рукописью, я быстро понял, почему с проекта сбежал предыдущий редактор: текст был абсолютно безграмотен как с литературной, так и с технической точки зрения. «Это г… гениальное произведение нужно переписывать полностью», — заявил я тогда руководителю редакции Кате Строгановой, — «даже я написал бы такую книжку лучше». «Можешь — напиши!», — лаконично ответила Катя. И я написал. Потом еще и еще. Как в том анекдоте про кота и пылесос: сначала было страшновато, но со временем втянулся. Мир за прошедшие 25 лет изменился до неузнаваемости: тиражи упали примерно в пять раз, книжки подорожали почти на столько же, да и технологии в IT стали совсем другими. Я за это время написал и выпустил более 50 книг и сам стал руководителем направления в книжном издательстве. Но я считаю, что именно сегодня — самый лучший момент, чтобы сделать быструю и успешную карьеру в качестве писателя, а конкретно — автора компьютерной литературы. Причем сейчас для этого потребуется гораздо меньше усилий, чем 25 лет назад. И вот почему

https://habr.com/ru/companies/bhv_publishing/articles/1026664/

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

Зачем айтишнику писать книги, и почему сейчас — самый лучший момент?

Привет, Хабр, на связи @holmogorov , руководитель проектов редакции компьютерной литературы издательства « БХВ ». Когда 25 лет назад, в 2001 году, в издательстве «Питер» вышла моя первая техническая книга, я и не думал строить карьеру в этом бизнесе. Можно сказать, я вообще попал в книжную сферу случайно: на тот момент я трудился в периодике, редактировал статьи для журнала «Магия ПК», а в свободное время делал сайты (кто тогда этим не занимался?). Однажды главред «Магии» Саша Альбов предложил мне халтуру: нужно было помочь коллегам из «Питера» отредактировать книжку по веб-дизайну, благо, я в этой области как раз неплохо разбирался. Однако ознакомившись с рукописью, я быстро понял, почему с проекта сбежал предыдущий редактор: текст был абсолютно безграмотен как с литературной, так и с технической точки зрения. «Это г… гениальное произведение нужно переписывать полностью», — заявил я тогда руководителю редакции Кате Строгановой, — «даже я написал бы такую книжку лучше». «Можешь — напиши!», — лаконично ответила Катя. И я написал. Потом еще и еще. Как в том анекдоте про кота и пылесос: сначала было страшновато, но со временем втянулся. Мир за прошедшие 25 лет изменился до неузнаваемости: тиражи упали примерно в пять раз, книжки подорожали почти на столько же, да и технологии в IT стали совсем другими. Я за это время написал и выпустил более 50 книг и сам стал руководителем направления в книжном издательстве. Но я считаю, что именно сегодня — самый лучший момент, чтобы сделать быструю и успешную карьеру в качестве писателя, а конкретно — автора компьютерной литературы. Причем сейчас для этого потребуется гораздо меньше усилий, чем 25 лет назад. И вот почему

https://habr.com/ru/companies/bhv_publishing/articles/1026664/

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

Зачем айтишнику писать книги, и почему сейчас — самый лучший момент?

Привет, Хабр, на связи @holmogorov , руководитель проектов редакции компьютерной литературы издательства « БХВ ». Когда 25 лет назад, в 2001 году, в издательстве «Питер» вышла моя первая техническая книга, я и не думал строить карьеру в этом бизнесе. Можно сказать, я вообще попал в книжную сферу случайно: на тот момент я трудился в периодике, редактировал статьи для журнала «Магия ПК», а в свободное время делал сайты (кто тогда этим не занимался?). Однажды главред «Магии» Саша Альбов предложил мне халтуру: нужно было помочь коллегам из «Питера» отредактировать книжку по веб-дизайну, благо, я в этой области как раз неплохо разбирался. Однако ознакомившись с рукописью, я быстро понял, почему с проекта сбежал предыдущий редактор: текст был абсолютно безграмотен как с литературной, так и с технической точки зрения. «Это г… гениальное произведение нужно переписывать полностью», — заявил я тогда руководителю редакции Кате Строгановой, — «даже я написал бы такую книжку лучше». «Можешь — напиши!», — лаконично ответила Катя. И я написал. Потом еще и еще. Как в том анекдоте про кота и пылесос: сначала было страшновато, но со временем втянулся. Мир за прошедшие 25 лет изменился до неузнаваемости: тиражи упали примерно в пять раз, книжки подорожали почти на столько же, да и технологии в IT стали совсем другими. Я за это время написал и выпустил более 50 книг и сам стал руководителем направления в книжном издательстве. Но я считаю, что именно сегодня — самый лучший момент, чтобы сделать быструю и успешную карьеру в качестве писателя, а конкретно — автора компьютерной литературы. Причем сейчас для этого потребуется гораздо меньше усилий, чем 25 лет назад. И вот почему

https://habr.com/ru/companies/bhv_publishing/articles/1026664/

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

Как организовать профессиональное сообщество техписателей в компании. Часть 1

Привет! На связи Наталья Нефедова — менеджер продукта и head of сообщества техписателей в

https://habr.com/ru/companies/cloud_ru/articles/1014974/

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

Как организовать профессиональное сообщество техписателей в компании. Часть 1

Привет! На связи Наталья Нефедова — менеджер продукта и head of сообщества техписателей в

https://habr.com/ru/companies/cloud_ru/articles/1014974/

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

Как организовать профессиональное сообщество техписателей в компании. Часть 1

Привет! На связи Наталья Нефедова — менеджер продукта и head of сообщества техписателей в

https://habr.com/ru/companies/cloud_ru/articles/1014974/

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

Как организовать профессиональное сообщество техписателей в компании. Часть 1

Привет! На связи Наталья Нефедова — менеджер продукта и head of сообщества техписателей в

https://habr.com/ru/companies/cloud_ru/articles/1014974/

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

Нужен ли синопсис технической документации? Личный опыт разработки

Разработка документации на создаваемые ИТ-продукты – это не только «правила хорошего тона», но и насущная необходимость. Ведь без технического задания невозможно зафиксировать требования к продукту, без руководства пользователя сложно грамотно продуктом пользоваться, без технической документации, описывающей продукт, сложно будет искать и исправлять ошибки и проводить необходимые доработки, когда в них возникнет необходимость, и т.д. Обычно документацию делают по одному из двух путей – либо используют стандарты, описывающие требования к составу, структуре и содержанию документов (например, ГОСТ 19-й и 34-й серий – ЕСПД и КСАС), либо самостоятельно разрабатывают документ, создавая его на основе собственного опыта или по существующим образцам, в т.ч. взятых из интернета. Но как же её правильно сделать? Мой ответ - начинать надо с синопсиса документов.

https://habr.com/ru/articles/1015118/

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

Нужен ли синопсис технической документации? Личный опыт разработки

Разработка документации на создаваемые ИТ-продукты – это не только «правила хорошего тона», но и насущная необходимость. Ведь без технического задания невозможно зафиксировать требования к продукту, без руководства пользователя сложно грамотно продуктом пользоваться, без технической документации, описывающей продукт, сложно будет искать и исправлять ошибки и проводить необходимые доработки, когда в них возникнет необходимость, и т.д. Обычно документацию делают по одному из двух путей – либо используют стандарты, описывающие требования к составу, структуре и содержанию документов (например, ГОСТ 19-й и 34-й серий – ЕСПД и КСАС), либо самостоятельно разрабатывают документ, создавая его на основе собственного опыта или по существующим образцам, в т.ч. взятых из интернета. Но как же её правильно сделать? Мой ответ - начинать надо с синопсиса документов.

https://habr.com/ru/articles/1015118/

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

Нужен ли синопсис технической документации? Личный опыт разработки

Разработка документации на создаваемые ИТ-продукты – это не только «правила хорошего тона», но и насущная необходимость. Ведь без технического задания невозможно зафиксировать требования к продукту, без руководства пользователя сложно грамотно продуктом пользоваться, без технической документации, описывающей продукт, сложно будет искать и исправлять ошибки и проводить необходимые доработки, когда в них возникнет необходимость, и т.д. Обычно документацию делают по одному из двух путей – либо используют стандарты, описывающие требования к составу, структуре и содержанию документов (например, ГОСТ 19-й и 34-й серий – ЕСПД и КСАС), либо самостоятельно разрабатывают документ, создавая его на основе собственного опыта или по существующим образцам, в т.ч. взятых из интернета. Но как же её правильно сделать? Мой ответ - начинать надо с синопсиса документов.

https://habr.com/ru/articles/1015118/

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

Нужен ли синопсис технической документации? Личный опыт разработки

Разработка документации на создаваемые ИТ-продукты – это не только «правила хорошего тона», но и насущная необходимость. Ведь без технического задания невозможно зафиксировать требования к продукту, без руководства пользователя сложно грамотно продуктом пользоваться, без технической документации, описывающей продукт, сложно будет искать и исправлять ошибки и проводить необходимые доработки, когда в них возникнет необходимость, и т.д. Обычно документацию делают по одному из двух путей – либо используют стандарты, описывающие требования к составу, структуре и содержанию документов (например, ГОСТ 19-й и 34-й серий – ЕСПД и КСАС), либо самостоятельно разрабатывают документ, создавая его на основе собственного опыта или по существующим образцам, в т.ч. взятых из интернета. Но как же её правильно сделать? Мой ответ - начинать надо с синопсиса документов.

https://habr.com/ru/articles/1015118/

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

Техпис на зоне: нужна ли свобода при написании документации

Документацию можно готовить где угодно и как угодно. Писать инструкции в многочисленных CCMS, публиковать сайты через генераторы наподобие Sphinx, применять сложные разметки вроде DITA, вести базы знаний в Confluence или вообще собирать файлы в Word. У каждого инструмента и подхода есть свои плюсы и минусы. Выбор зависит от множества факторов: сложности, требований к результату, потребителя контента, бюджета отдела, объема накопившегося легаси — да и просто моды в профессиональной среде. Но что если посмотреть на вопрос с другой стороны? Что если выбирать и проектировать систему документирования исходя из того, сколько свободы предоставляется техническому писателю? Давайте выкрутим регулятор свободы на максималку сначала в одну сторону, когда техпис не имеет абсолютно никаких рамок и ограничений, а затем в противоположную, когда он тотально несвободен. Какие преимущества будут у каждой из этих двух крайностей и какие выводы можно будет сделать по итогу такого мысленного эксперимента — об этом моя статья.

https://habr.com/ru/companies/pt/articles/1013828/

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

Техпис на зоне: нужна ли свобода при написании документации

Документацию можно готовить где угодно и как угодно. Писать инструкции в многочисленных CCMS, публиковать сайты через генераторы наподобие Sphinx, применять сложные разметки вроде DITA, вести базы знаний в Confluence или вообще собирать файлы в Word. У каждого инструмента и подхода есть свои плюсы и минусы. Выбор зависит от множества факторов: сложности, требований к результату, потребителя контента, бюджета отдела, объема накопившегося легаси — да и просто моды в профессиональной среде. Но что если посмотреть на вопрос с другой стороны? Что если выбирать и проектировать систему документирования исходя из того, сколько свободы предоставляется техническому писателю? Давайте выкрутим регулятор свободы на максималку сначала в одну сторону, когда техпис не имеет абсолютно никаких рамок и ограничений, а затем в противоположную, когда он тотально несвободен. Какие преимущества будут у каждой из этих двух крайностей и какие выводы можно будет сделать по итогу такого мысленного эксперимента — об этом моя статья.

https://habr.com/ru/companies/pt/articles/1013828/

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

Техпис на зоне: нужна ли свобода при написании документации

Документацию можно готовить где угодно и как угодно. Писать инструкции в многочисленных CCMS, публиковать сайты через генераторы наподобие Sphinx, применять сложные разметки вроде DITA, вести базы знаний в Confluence или вообще собирать файлы в Word. У каждого инструмента и подхода есть свои плюсы и минусы. Выбор зависит от множества факторов: сложности, требований к результату, потребителя контента, бюджета отдела, объема накопившегося легаси — да и просто моды в профессиональной среде. Но что если посмотреть на вопрос с другой стороны? Что если выбирать и проектировать систему документирования исходя из того, сколько свободы предоставляется техническому писателю? Давайте выкрутим регулятор свободы на максималку сначала в одну сторону, когда техпис не имеет абсолютно никаких рамок и ограничений, а затем в противоположную, когда он тотально несвободен. Какие преимущества будут у каждой из этих двух крайностей и какие выводы можно будет сделать по итогу такого мысленного эксперимента — об этом моя статья.

https://habr.com/ru/companies/pt/articles/1013828/

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

Техпис на зоне: нужна ли свобода при написании документации

Документацию можно готовить где угодно и как угодно. Писать инструкции в многочисленных CCMS, публиковать сайты через генераторы наподобие Sphinx, применять сложные разметки вроде DITA, вести базы знаний в Confluence или вообще собирать файлы в Word. У каждого инструмента и подхода есть свои плюсы и минусы. Выбор зависит от множества факторов: сложности, требований к результату, потребителя контента, бюджета отдела, объема накопившегося легаси — да и просто моды в профессиональной среде. Но что если посмотреть на вопрос с другой стороны? Что если выбирать и проектировать систему документирования исходя из того, сколько свободы предоставляется техническому писателю? Давайте выкрутим регулятор свободы на максималку сначала в одну сторону, когда техпис не имеет абсолютно никаких рамок и ограничений, а затем в противоположную, когда он тотально несвободен. Какие преимущества будут у каждой из этих двух крайностей и какие выводы можно будет сделать по итогу такого мысленного эксперимента — об этом моя статья.

https://habr.com/ru/companies/pt/articles/1013828/

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

Как мы избавились от копипаста в технической документации

Всем привет. Меня зовут Никита, я руковожу командой Цикл‑ОН. Мы уже более 5 лет ведем проекты по заказной разработке ПО и, как и многие, сталкиваемся с необходимостью разработки не только качественного кода, но и документацию на продукты. В нашей нише особенность, что заказчики живут в парадигме ГОСТа. Я бы здесь хотел оставить небольшую заметку о нашем опыте — как то, что для начаиналось как откровенное мучение превратилось сначала в умную идеологию, а по итогу в самостоятельное решение для подготовки документации.

https://habr.com/ru/articles/1010296/

#технический_писатель #ГОСТ_34 #документация #техническое_задание

Как мы избавились от копипаста в технической документации

Всем привет. Меня зовут Никита, я руковожу командой Цикл‑ОН. Мы уже более 5 лет ведем проекты по заказной разработке ПО и, как и многие, сталкиваемся с необходимостью разработки не только качественного кода, но и документацию на продукты. В нашей нише особенность, что заказчики живут в парадигме ГОСТа. Я бы здесь хотел оставить небольшую заметку о нашем опыте — как то, что для начаиналось как откровенное мучение превратилось сначала в умную идеологию, а по итогу в самостоятельное решение для подготовки документации.

https://habr.com/ru/articles/1010296/

#технический_писатель #ГОСТ_34 #документация #техническое_задание

Как мы избавились от копипаста в технической документации

Всем привет. Меня зовут Никита, я руковожу командой Цикл‑ОН. Мы уже более 5 лет ведем проекты по заказной разработке ПО и, как и многие, сталкиваемся с необходимостью разработки не только качественного кода, но и документацию на продукты. В нашей нише особенность, что заказчики живут в парадигме ГОСТа. Я бы здесь хотел оставить небольшую заметку о нашем опыте — как то, что для начаиналось как откровенное мучение превратилось сначала в умную идеологию, а по итогу в самостоятельное решение для подготовки документации.

https://habr.com/ru/articles/1010296/

#технический_писатель #ГОСТ_34 #документация #техническое_задание

Как мы избавились от копипаста в технической документации

Всем привет. Меня зовут Никита, я руковожу командой Цикл‑ОН. Мы уже более 5 лет ведем проекты по заказной разработке ПО и, как и многие, сталкиваемся с необходимостью разработки не только качественного кода, но и документацию на продукты. В нашей нише особенность, что заказчики живут в парадигме ГОСТа. Я бы здесь хотел оставить небольшую заметку о нашем опыте — как то, что для начаиналось как откровенное мучение превратилось сначала в умную идеологию, а по итогу в самостоятельное решение для подготовки документации.

https://habr.com/ru/articles/1010296/

#технический_писатель #ГОСТ_34 #документация #техническое_задание

Evidence-based тимбилдинг: как мы команду дружим

Кажется, только недавно закончились зимние каникулы, а мы уже начинаем мечтать о теплых летних днях отдыха. Сейчас самое время заранее подумать о летнем выезде для своей команды! В этой статье хочу рассказать, как мы в Positive Technologies проводим тимбилдинги для технических писателей. А еще хочу поразмышлять вместе с популярными авторами книг по менеджменту, как организовать такой праздник, чтобы сплотить коллектив.

https://habr.com/ru/companies/pt/articles/995148/

#тимбилдинг #тимлидство #управление_командой #технический_писатель #teambuilding #командный_дух #сплочение_коллектива #teamwork

Evidence-based тимбилдинг: как мы команду дружим

Кажется, только недавно закончились зимние каникулы, а мы уже начинаем мечтать о теплых летних днях отдыха. Сейчас самое время заранее подумать о летнем выезде для своей команды! В этой статье хочу рассказать, как мы в Positive Technologies проводим тимбилдинги для технических писателей. А еще хочу поразмышлять вместе с популярными авторами книг по менеджменту, как организовать такой праздник, чтобы сплотить коллектив.

https://habr.com/ru/companies/pt/articles/995148/

#тимбилдинг #тимлидство #управление_командой #технический_писатель #teambuilding #командный_дух #сплочение_коллектива #teamwork

Evidence-based тимбилдинг: как мы команду дружим

Кажется, только недавно закончились зимние каникулы, а мы уже начинаем мечтать о теплых летних днях отдыха. Сейчас самое время заранее подумать о летнем выезде для своей команды! В этой статье хочу рассказать, как мы в Positive Technologies проводим тимбилдинги для технических писателей. А еще хочу поразмышлять вместе с популярными авторами книг по менеджменту, как организовать такой праздник, чтобы сплотить коллектив.

https://habr.com/ru/companies/pt/articles/995148/

#тимбилдинг #тимлидство #управление_командой #технический_писатель #teambuilding #командный_дух #сплочение_коллектива #teamwork

Evidence-based тимбилдинг: как мы команду дружим

Кажется, только недавно закончились зимние каникулы, а мы уже начинаем мечтать о теплых летних днях отдыха. Сейчас самое время заранее подумать о летнем выезде для своей команды! В этой статье хочу рассказать, как мы в Positive Technologies проводим тимбилдинги для технических писателей. А еще хочу поразмышлять вместе с популярными авторами книг по менеджменту, как организовать такой праздник, чтобы сплотить коллектив.

https://habr.com/ru/companies/pt/articles/995148/

#тимбилдинг #тимлидство #управление_командой #технический_писатель #teambuilding #командный_дух #сплочение_коллектива #teamwork

Вашего техписа и там, и тут передают: образ разработчика документации в кино

Несмотря на длинную историю, профессия технического писателя в массовом сознании так и не закрепилась. Если ты техпис, то наверняка сталкивался с необходимостью объяснять родным, соседям по гаражу и терапевту о том, что это за зверь такой. Я, например, в какой‑то момент махнул рукой и на вопрос о том, кем ты работаешь, отвечаю: пишу руководства пользователя к программному обеспечению. Длинновато, зато так меня понимают сразу. Причины безвестности техписов связаны в том числе с их нерепрезентативностью в поп‑культуре. Визуально разработка документов не отличается от печатания по клавиатуре, а на того, кто это делает, не напялишь камуфляж, белый халат или иную спецодежду. Взять, к примеру, программистов. Они тоже работают за компьютером, но их труд сопровождают бегущий водопад строчек с зелеными письменами на черном фоне и эффектный интерфейс IDE‑шки. Да и вообще, в кино создатели софта меняют своим кодом мир, вершат судьбы. Короче, их труд не только добавляет жира картинке, но и привносит в сюжет захватывающие перспективы. (И это я еще не говорю про хакеров.) Написание же документации считывается обывателем как ответвление бюрократии. Лучше уж тогда Кафку экранизировать. Поэтому можно было бы предположить, что техписатели в киноискусстве отсутствуют как класс. И я тоже так думал. Однако, покопавшись в теме, обнаружил, что кое‑какое игровое кино сняли и про наш народ.

https://habr.com/ru/companies/pt/articles/985252/

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

Вашего техписа и там, и тут передают: образ разработчика документации в кино

Несмотря на длинную историю, профессия технического писателя в массовом сознании так и не закрепилась. Если ты техпис, то наверняка сталкивался с необходимостью объяснять родным, соседям по гаражу и терапевту о том, что это за зверь такой. Я, например, в какой‑то момент махнул рукой и на вопрос о том, кем ты работаешь, отвечаю: пишу руководства пользователя к программному обеспечению. Длинновато, зато так меня понимают сразу. Причины безвестности техписов связаны в том числе с их нерепрезентативностью в поп‑культуре. Визуально разработка документов не отличается от печатания по клавиатуре, а на того, кто это делает, не напялишь камуфляж, белый халат или иную спецодежду. Взять, к примеру, программистов. Они тоже работают за компьютером, но их труд сопровождают бегущий водопад строчек с зелеными письменами на черном фоне и эффектный интерфейс IDE‑шки. Да и вообще, в кино создатели софта меняют своим кодом мир, вершат судьбы. Короче, их труд не только добавляет жира картинке, но и привносит в сюжет захватывающие перспективы. (И это я еще не говорю про хакеров.) Написание же документации считывается обывателем как ответвление бюрократии. Лучше уж тогда Кафку экранизировать. Поэтому можно было бы предположить, что техписатели в киноискусстве отсутствуют как класс. И я тоже так думал. Однако, покопавшись в теме, обнаружил, что кое‑какое игровое кино сняли и про наш народ.

https://habr.com/ru/companies/pt/articles/985252/

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

Вашего техписа и там, и тут передают: образ разработчика документации в кино

Несмотря на длинную историю, профессия технического писателя в массовом сознании так и не закрепилась. Если ты техпис, то наверняка сталкивался с необходимостью объяснять родным, соседям по гаражу и терапевту о том, что это за зверь такой. Я, например, в какой‑то момент махнул рукой и на вопрос о том, кем ты работаешь, отвечаю: пишу руководства пользователя к программному обеспечению. Длинновато, зато так меня понимают сразу. Причины безвестности техписов связаны в том числе с их нерепрезентативностью в поп‑культуре. Визуально разработка документов не отличается от печатания по клавиатуре, а на того, кто это делает, не напялишь камуфляж, белый халат или иную спецодежду. Взять, к примеру, программистов. Они тоже работают за компьютером, но их труд сопровождают бегущий водопад строчек с зелеными письменами на черном фоне и эффектный интерфейс IDE‑шки. Да и вообще, в кино создатели софта меняют своим кодом мир, вершат судьбы. Короче, их труд не только добавляет жира картинке, но и привносит в сюжет захватывающие перспективы. (И это я еще не говорю про хакеров.) Написание же документации считывается обывателем как ответвление бюрократии. Лучше уж тогда Кафку экранизировать. Поэтому можно было бы предположить, что техписатели в киноискусстве отсутствуют как класс. И я тоже так думал. Однако, покопавшись в теме, обнаружил, что кое‑какое игровое кино сняли и про наш народ.

https://habr.com/ru/companies/pt/articles/985252/

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

Вашего техписа и там, и тут передают: образ разработчика документации в кино

Несмотря на длинную историю, профессия технического писателя в массовом сознании так и не закрепилась. Если ты техпис, то наверняка сталкивался с необходимостью объяснять родным, соседям по гаражу и терапевту о том, что это за зверь такой. Я, например, в какой‑то момент махнул рукой и на вопрос о том, кем ты работаешь, отвечаю: пишу руководства пользователя к программному обеспечению. Длинновато, зато так меня понимают сразу. Причины безвестности техписов связаны в том числе с их нерепрезентативностью в поп‑культуре. Визуально разработка документов не отличается от печатания по клавиатуре, а на того, кто это делает, не напялишь камуфляж, белый халат или иную спецодежду. Взять, к примеру, программистов. Они тоже работают за компьютером, но их труд сопровождают бегущий водопад строчек с зелеными письменами на черном фоне и эффектный интерфейс IDE‑шки. Да и вообще, в кино создатели софта меняют своим кодом мир, вершат судьбы. Короче, их труд не только добавляет жира картинке, но и привносит в сюжет захватывающие перспективы. (И это я еще не говорю про хакеров.) Написание же документации считывается обывателем как ответвление бюрократии. Лучше уж тогда Кафку экранизировать. Поэтому можно было бы предположить, что техписатели в киноискусстве отсутствуют как класс. И я тоже так думал. Однако, покопавшись в теме, обнаружил, что кое‑какое игровое кино сняли и про наш народ.

https://habr.com/ru/companies/pt/articles/985252/

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

Как техписатели Just AI экономят время с помощью своих же AI-продуктов

Привет, Хабр! Меня зовут Даниил Смородин, я работаю техническим писателем в Just AI — компании, которая разрабатывает решения на базе искусственного интеллекта. Когда каждый день пишешь об AI, рано или поздно задаёшься вопросом: а можно ли применить его в собственной работе?

В этой статье расскажу, как мы автоматизировали подготовку release notes и первичную вычитку с помощью наших продуктов.

https://habr.com/ru/companies/just_ai/articles/968418/

#технический_писатель #ai #release_notes #техписатели #llm #vs_code #aiприложения #нейросети #работа_с_документацией #техническая_документация

Как техписатели Just AI экономят время с помощью своих же AI-продуктов

Привет, Хабр! Меня зовут Даниил Смородин, я работаю техническим писателем в Just AI — компании, которая разрабатывает решения на базе искусственного интеллекта. Когда каждый день пишешь об AI, рано или поздно задаёшься вопросом: а можно ли применить его в собственной работе?

В этой статье расскажу, как мы автоматизировали подготовку release notes и первичную вычитку с помощью наших продуктов.

https://habr.com/ru/companies/just_ai/articles/968418/

#технический_писатель #ai #release_notes #техписатели #llm #vs_code #aiприложения #нейросети #работа_с_документацией #техническая_документация

Как техписатели Just AI экономят время с помощью своих же AI-продуктов

Привет, Хабр! Меня зовут Даниил Смородин, я работаю техническим писателем в Just AI — компании, которая разрабатывает решения на базе искусственного интеллекта. Когда каждый день пишешь об AI, рано или поздно задаёшься вопросом: а можно ли применить его в собственной работе?

В этой статье расскажу, как мы автоматизировали подготовку release notes и первичную вычитку с помощью наших продуктов.

https://habr.com/ru/companies/just_ai/articles/968418/

#технический_писатель #ai #release_notes #техписатели #llm #vs_code #aiприложения #нейросети #работа_с_документацией #техническая_документация

Как техписатели Just AI экономят время с помощью своих же AI-продуктов

Привет, Хабр! Меня зовут Даниил Смородин, я работаю техническим писателем в Just AI — компании, которая разрабатывает решения на базе искусственного интеллекта. Когда каждый день пишешь об AI, рано или поздно задаёшься вопросом: а можно ли применить его в собственной работе?

В этой статье расскажу, как мы автоматизировали подготовку release notes и первичную вычитку с помощью наших продуктов.

https://habr.com/ru/companies/just_ai/articles/968418/

#технический_писатель #ai #release_notes #техписатели #llm #vs_code #aiприложения #нейросети #работа_с_документацией #техническая_документация

Фильтруй. Переиспользуй. Собирай. Почему DITA — идеальный формат для разработки сложной технической документации

Формат DITA позволяет полностью сосредоточиться на содержании документа и не думать о его оформлении. Кроме того, этот инструмент помогает легко и быстро вносить изменения и дополнения в уже написанные ранее документы. Если с DITA как следует разобраться, то потом написание сложных технических документов существенно упростится. В этой статье я расскажу об основных достоинствах DITA.

https://habr.com/ru/companies/bercut/articles/951260/

#dita #dita_open_toolkit #документация #технический_писатель #пользовательская_документация #xml #форматы_документов #docascode #техническая_документация #bercut

Фильтруй. Переиспользуй. Собирай. Почему DITA — идеальный формат для разработки сложной технической документации

Формат DITA позволяет полностью сосредоточиться на содержании документа и не думать о его оформлении. Кроме того, этот инструмент помогает легко и быстро вносить изменения и дополнения в уже написанные ранее документы. Если с DITA как следует разобраться, то потом написание сложных технических документов существенно упростится. В этой статье я расскажу об основных достоинствах DITA.

https://habr.com/ru/companies/bercut/articles/951260/

#dita #dita_open_toolkit #документация #технический_писатель #пользовательская_документация #xml #форматы_документов #docascode #техническая_документация #bercut

Фильтруй. Переиспользуй. Собирай. Почему DITA — идеальный формат для разработки сложной технической документации

Формат DITA позволяет полностью сосредоточиться на содержании документа и не думать о его оформлении. Кроме того, этот инструмент помогает легко и быстро вносить изменения и дополнения в уже написанные ранее документы. Если с DITA как следует разобраться, то потом написание сложных технических документов существенно упростится. В этой статье я расскажу об основных достоинствах DITA.

https://habr.com/ru/companies/bercut/articles/951260/

#dita #dita_open_toolkit #документация #технический_писатель #пользовательская_документация #xml #форматы_документов #docascode #техническая_документация #bercut

Фильтруй. Переиспользуй. Собирай. Почему DITA — идеальный формат для разработки сложной технической документации

Формат DITA позволяет полностью сосредоточиться на содержании документа и не думать о его оформлении. Кроме того, этот инструмент помогает легко и быстро вносить изменения и дополнения в уже написанные ранее документы. Если с DITA как следует разобраться, то потом написание сложных технических документов существенно упростится. В этой статье я расскажу об основных достоинствах DITA.

https://habr.com/ru/companies/bercut/articles/951260/

#dita #dita_open_toolkit #документация #технический_писатель #пользовательская_документация #xml #форматы_документов #docascode #техническая_документация #bercut

Генеральная уборка базы знаний: плюсы, подводные камни, минусов не будет

Привет, Хабр. Меня зовут Мария Рылик, я — старший контент-менеджер группы управления пользовательским опытом веб-поддержки «Лаборатории Касперского». И полтора года назад я столкнулась с распространенной в техписовских кругах проблемой: децентрализованной базой знаний. Чтобы найти инфу по работе с конкретным продуктом, приходилось по крупицам искать ее в разных статьях, в большинстве своем имеющих мало общего с конкретной задачей, которую я пыталась решить. Из-за этого в поддержку приходилось обращаться даже в несложных ситуациях. В результате поддержка, вместо того чтобы использовать свое время для решения действительно сложных, специфичных проблем, была постоянно перегружена однотипными и достаточно распространенными вопросами, ответы на которые можно было бы поместить в отдельную статью. И все из-за отсутствия систематизированного подхода. В этой статье я расскажу, как мы с командой провели генеральную уборку баз знаний, наступили в процессе на всевозможные швабры грабли, но в итоге помогли и юзерам продуктов, и нашему саппорту: базами знаний стали активно пользоваться, снизилось количество итераций общения по проблеме от первого запроса саппорту до окончательного решения.

https://habr.com/ru/companies/kaspersky/articles/968582/

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

Генеральная уборка базы знаний: плюсы, подводные камни, минусов не будет

Привет, Хабр. Меня зовут Мария Рылик, я — старший контент-менеджер группы управления пользовательским опытом веб-поддержки «Лаборатории Касперского». И полтора года назад я столкнулась с распространенной в техписовских кругах проблемой: децентрализованной базой знаний. Чтобы найти инфу по работе с конкретным продуктом, приходилось по крупицам искать ее в разных статьях, в большинстве своем имеющих мало общего с конкретной задачей, которую я пыталась решить. Из-за этого в поддержку приходилось обращаться даже в несложных ситуациях. В результате поддержка, вместо того чтобы использовать свое время для решения действительно сложных, специфичных проблем, была постоянно перегружена однотипными и достаточно распространенными вопросами, ответы на которые можно было бы поместить в отдельную статью. И все из-за отсутствия систематизированного подхода. В этой статье я расскажу, как мы с командой провели генеральную уборку баз знаний, наступили в процессе на всевозможные швабры грабли, но в итоге помогли и юзерам продуктов, и нашему саппорту: базами знаний стали активно пользоваться, снизилось количество итераций общения по проблеме от первого запроса саппорту до окончательного решения.

https://habr.com/ru/companies/kaspersky/articles/968582/

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

Генеральная уборка базы знаний: плюсы, подводные камни, минусов не будет

Привет, Хабр. Меня зовут Мария Рылик, я — старший контент-менеджер группы управления пользовательским опытом веб-поддержки «Лаборатории Касперского». И полтора года назад я столкнулась с распространенной в техписовских кругах проблемой: децентрализованной базой знаний. Чтобы найти инфу по работе с конкретным продуктом, приходилось по крупицам искать ее в разных статьях, в большинстве своем имеющих мало общего с конкретной задачей, которую я пыталась решить. Из-за этого в поддержку приходилось обращаться даже в несложных ситуациях. В результате поддержка, вместо того чтобы использовать свое время для решения действительно сложных, специфичных проблем, была постоянно перегружена однотипными и достаточно распространенными вопросами, ответы на которые можно было бы поместить в отдельную статью. И все из-за отсутствия систематизированного подхода. В этой статье я расскажу, как мы с командой провели генеральную уборку баз знаний, наступили в процессе на всевозможные швабры грабли, но в итоге помогли и юзерам продуктов, и нашему саппорту: базами знаний стали активно пользоваться, снизилось количество итераций общения по проблеме от первого запроса саппорту до окончательного решения.

https://habr.com/ru/companies/kaspersky/articles/968582/

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

Генеральная уборка базы знаний: плюсы, подводные камни, минусов не будет

Привет, Хабр. Меня зовут Мария Рылик, я — старший контент-менеджер группы управления пользовательским опытом веб-поддержки «Лаборатории Касперского». И полтора года назад я столкнулась с распространенной в техписовских кругах проблемой: децентрализованной базой знаний. Чтобы найти инфу по работе с конкретным продуктом, приходилось по крупицам искать ее в разных статьях, в большинстве своем имеющих мало общего с конкретной задачей, которую я пыталась решить. Из-за этого в поддержку приходилось обращаться даже в несложных ситуациях. В результате поддержка, вместо того чтобы использовать свое время для решения действительно сложных, специфичных проблем, была постоянно перегружена однотипными и достаточно распространенными вопросами, ответы на которые можно было бы поместить в отдельную статью. И все из-за отсутствия систематизированного подхода. В этой статье я расскажу, как мы с командой провели генеральную уборку баз знаний, наступили в процессе на всевозможные швабры грабли, но в итоге помогли и юзерам продуктов, и нашему саппорту: базами знаний стали активно пользоваться, снизилось количество итераций общения по проблеме от первого запроса саппорту до окончательного решения.

https://habr.com/ru/companies/kaspersky/articles/968582/

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

Космотекст: отправляем статьи в космос — и объявляем победителей 🚀

Привет от Хабра! Несем вам буквально космическую новость — мы подвели итоги конкурса космических статей и выбрали те, что отправятся в настоящий КОСМОС 🛸 . А еще отобрали автора лучшей статьи за время существования Хабра, который забирает экскурсию на Байконур! Рассказываем, какие авторы стали космическими победителями и о чем они написали.

https://habr.com/ru/specials/968096/

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

Космотекст: отправляем статьи в космос — и объявляем победителей 🚀

Привет от Хабра! Несем вам буквально космическую новость — мы подвели итоги конкурса космических статей и выбрали те, что отправятся в настоящий КОСМОС 🛸 . А еще отобрали автора лучшей статьи за время существования Хабра, который забирает экскурсию на Байконур! Рассказываем, какие авторы стали космическими победителями и о чем они написали.

https://habr.com/ru/specials/968096/

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

Космотекст: отправляем статьи в космос — и объявляем победителей 🚀

Привет от Хабра! Несем вам буквально космическую новость — мы подвели итоги конкурса космических статей и выбрали те, что отправятся в настоящий КОСМОС 🛸 . А еще отобрали автора лучшей статьи за время существования Хабра, который забирает экскурсию на Байконур! Рассказываем, какие авторы стали космическими победителями и о чем они написали.

https://habr.com/ru/specials/968096/

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

Космотекст: отправляем статьи в космос — и объявляем победителей 🚀

Привет от Хабра! Несем вам буквально космическую новость — мы подвели итоги конкурса космических статей и выбрали те, что отправятся в настоящий КОСМОС 🛸 . А еще отобрали автора лучшей статьи за время существования Хабра, который забирает экскурсию на Байконур! Рассказываем, какие авторы стали космическими победителями и о чем они написали.

https://habr.com/ru/specials/968096/

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

Размышления о документации

Вряд ли найдётся кто-либо, кто в здравом уме и ясной памяти будет отрицать необходимость документации. Любой продукт имеет (или должен иметь) свою документацию. Как минимум – инструкцию о том, как этим продуктом пользоваться. Производители почти всегда указывают – « прежде чем начать пользоваться нашим продуктом, внимательно ознакомьтесь с инструкцией ». Но дело почти никогда не ограничивается инструкцией пользователя. Производители также составляют и другую документацию – техническую, эксплуатационную. Но ЧТО же должен создавать автор документации? Что должна в себя включать документация, когда, на каком этапе и в каком объёме она должна создаваться, ЧТО она должна содержать, когда, кому и при каких обстоятельствах она может потребоваться? В данной статье мы и поразмышляем об этом... Читать статью

https://habr.com/ru/articles/958076/

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

Размышления о документации

Вряд ли найдётся кто-либо, кто в здравом уме и ясной памяти будет отрицать необходимость документации. Любой продукт имеет (или должен иметь) свою документацию. Как минимум – инструкцию о том, как этим продуктом пользоваться. Производители почти всегда указывают – « прежде чем начать пользоваться нашим продуктом, внимательно ознакомьтесь с инструкцией ». Но дело почти никогда не ограничивается инструкцией пользователя. Производители также составляют и другую документацию – техническую, эксплуатационную. Но ЧТО же должен создавать автор документации? Что должна в себя включать документация, когда, на каком этапе и в каком объёме она должна создаваться, ЧТО она должна содержать, когда, кому и при каких обстоятельствах она может потребоваться? В данной статье мы и поразмышляем об этом... Читать статью

https://habr.com/ru/articles/958076/

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