Всё для технического документирования
+7 (925) 328-76-00
Разработка технической документации
Курсы для технических писателей
Программное обеспечение

Новости о техническом писательстве

Atlassian Confluence в качестве среды для создания технической документации

07.10.2016

0Предлагаем Вашему вниманию статью слушателя нашего курса «Разработка технических текстов и документации» Георгия Полищука, посвящённую одной из наиболее популярных платформ для организации совместной работы над информацией Atlassian Confluence, которую часто используют в том числе для организации процессов документирования.

Компания «ПроТекст» проводит курс «Техническая документация в Atlassian Confluence». Мы учим работать в программе «с нуля», но даже если вы уже научились основам работы в программе и у вас есть вопросы или что-то не получается — добро пожаловать на курс! Опытный преподаватель подскажет, поможет, научит.

Содержание

ВВЕДЕНИЕ

КРАТКО О ПРИНЦИПАХ РАБОТЫ CONFLUENCE

ДОКУМЕНТИРОВАНИЕ В CONFLUENCE

Задачи

Решения

Экспорт документации в файлы MS Word

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

Создание эксплуатационной документации для различных версий продукта

Привязка бизнес-процессов

Создание «динамических» отчетов

Импорт документов MS Word

Еще несколько полезных плагинов

ЗАКЛЮЧЕНИЕ

Введение

Австралийская компания Atlassian известна своими программными продуктами для управления проектами разработки программного обеспечения. Широкую популярность завоевали инструмент управления проектами и баг-трекер JIRA, а также система совместной работы над информацией Confluence. Читать дальше…



Спецификации, ложь и видео: Документальный контроль фильмов

29.07.2016

NoJarJarОдин из главных драйверов любой работы – это контроль за её выполнением. А так как «офис без бумажек» пока ещё остаётся утопией, этот самый контроль нужно ещё и задокументировать. А иногда сделать это очень и очень непросто.


Пока я проводил исследования лазил в гугле, чтобы написать эту статью, я пребывал в шоке. В шоке, потому что узнал, что фразы «документальный контроль видео» и «документальный контроль фильмов» в гугле не найти [это явление получило название Googlenopes – прим.пер.]. Ну, правда, нашлось восемь результатов на запрос «контроль версий видео», но (а) восемь результатов во всем Интернете – это даже не смешно и (б) контроль версий и документальный контроль – не одно и то же. Контроль версий означает, что версия Б хранится отдельно от версии А. А документальный контроль означает (среди многого другого), что все мои пользователи используют версию Б видео, и ни один из них не использует версию A. Читать дальше…



Адвокат пользователя: лучше приносить пользу, а не внушать восхищение

15.07.2016

strСегодня мы представим вам нового автора уже известного нам цикла статей «Адвокат пользователя». Фил Девис всю жизнь работает над тем, чтобы улучшить жизнь пользователей и решил поделиться некоторыми наблюдениями.


В «Адвокате пользователя» всё меняется. Нила завалили требованиями графиков запуска и конференц-презентаций. Я мог бы весь день читать его остроумные анализы, но теперь моя очередь добавить что-то к вдумчивой, проницательной практической многолетней  работе Джеффа, Марка и Нила.

Так кто же этот новый парень? Я не собираюсь занимать чьё-то место и не могу утверждать, что буду идейным лидером или гуру. Я работал в качестве технического писателя 20 лет. Я начал в сфере аппаратных средств, программного обеспечения, руководил командой писателей, и теперь я сольный писатель и отвечаю за производство документации, интеграцию и распределение продуктов более 10 лет, API – более 12 лет, и заказных фирменных решений для оценки ребрендинга клиентов по всему миру, а также играю свою роль во внутренних и внешних релизах. Читать дальше…



На заметку руководителю: помогаем членам команды развиваться

07.07.2016

00Алисса Фокс, директор по разработке информации и программному управлению компании NetIQ Corporation, принадлежит к тому редкому типу руководителей, которые не боятся публично признавать свои промахи и недоработки. И это даёт отличную возможность поучиться не на собственных, а на чужих ошибках.


Я на днях прочитала пост с заголовком «Когда хорошо НЕ развиваться? Подсказка: Никогда«. Я сразу подумала: «Ну, конечно же, мы всегда должны учиться». Я стала читать дальше и поняла, что не всегда выполняю свои обязанности лидера и не помогаю моим сотрудникам профессионально развиваться. Читайте дальше, чтобы узнать, почему, и как я планирую исправиться.

Что подразумевается под профессиональным развитием?

Профессиональное развитие по-разному воспринимается разными людьми и организациями, которые их нанимают. Для некоторых оно означает, что они выполнили много работы, поэтому заслуживают поощрения. Для других это означает улучшение той работы, которую они уже делают. Но для меня оно подразумевает использование возможностей получать новые знания, которые могут помочь вам быть более эффективным в вашей работе, расширять набор навыков, и помогать развивать свою команду и организацию. Читать дальше…



Краткое введение в управление бизнес-процессами для разработчика контента

15.04.2016

14.04.2016Простейшие рабочие действия стали занимать слишком много времени? Заметили бумажную волокиту? Считаете, что бизнес-процессы в вашей компании устарели? А может быть, так считает руководство, но не знает, что с этим делать? Тогда наша статья именно для вас. Крис Денман рассказывает о том, как сменить направление деятельности, не меняя общей сферы, и при этом вырасти профессионально и заслужить уважение руководства.


Вы потратили месяцы, а, может быть, и годы, создавая контент для вашей организации. За это время вы изучили все тонкости процессов организации, обнаружили сильные и слабые стороны. Это открывает отличные возможности для вас и для вашего работодателя. Ну а теперь, по собственному ли желанию или по необходимости, пришло время систематизировать все свои знания о процессах и представить их по-другому. Возможно, вас назначили экспертом в области разработки контента, чтобы вы могли использовать свои знания о процессах организации и найти способы их оптимизации. Честно говоря, это сложная задача, но не непреодолимая. Следуя практике, известной как Управление бизнес-процессами (УБП), вы можете впустить в организацию ветер перемен. Читать дальше…



На заметку руководителю: Развитие карьерной лестницы технического коммуникатора

12.02.2016

ladder-libraryАлисса Фокс, директор по разработке информации и программному управлению компании NetIQ Corporation, обобщает свой опыт по управлению продвижением технических писателей в компании. Из статьи руководители предприятий узнают, по каким критериям организовать карьерные возможности для своих технических писателей, а технические писатели смогут свериться, не пора ли им просить повышение и что нужно делать, чтобы претендовать на более высокие карьерные уровни.


 

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



На заметку руководителю: Бюджетирование команды по разработке информации

27.11.2015

00Алисса Фокс, директор по разработке информации и программному управлению компании NetIQ Corporation, рассказывает о том, как продумать бюджет для успешной работы команды по разработке информации. Статья будет полезна руководителям отделов технической документации, менеджерам ИТ-отделов или менеджерам проектов.


Понимание и тщательное отслеживание затрат и доходов, связанных с вашей командой по разработке информации помогает вам ответственно участвовать в формировании общей чистой прибыли вашей компании. Рассмотрите следующие области, когда определяетесь с затратами на следующий финансовый год.

Программное обеспечение, «железо» и инструменты

Выделение средств на покупку инструментов делается не для удовольствия – это необходимость. Если вы не планируете смену основных инструментов, эта бюджетная категория будет в основном включать расходы на обновления или продление подписки на облачные сервисы и техническую поддержку. Однако в зависимости от размера вашей команды стоимость, скажем, обновления FrameMaker, может быть значительной. Эта категория должна включать не только инструменты для авторинга, но и другие платные инструменты, такие как программы для создания графики, софт для работы со скриншотами или программы для совместной работы, которые используются вашей командой. Читать дальше…



Практические советы Стивена Кинга для технических писателей

31.10.2015

01Представляем вашему вниманию статью Рикки Эндсли (Rikki Endsley), менеджера по сообществу Opensource.com, ранее работавщую над продвижением идей свободного ПО в Red Hat. Статья посвящена основным принципам технического документирования для широкой аудитории.


Даже если вам не нравится писать, и вы не собираетесь становиться профессиональным техническим писателем, есть вероятность, что в некоторые периоды вашей карьеры вам придётся писать проекты докладов, материалы для почтовой рассылки или технические статьи. И, вооружившись несколькими практическими советами, которыми с высоты своего опыта поделился Стивен Кинг, вы сможете развить свои способности ещё до того, как начнёте писать. И, при правильном планировании, вы сможете легко модифицировать свои материалы для различных категорий пользователей. Читать дальше…



Вебинар для руководителей «Техническое документирование для бизнеса: проблемы и решения»

21.10.2015

15 октября мы провели вебинар для руководителей «Техническое документирование для бизнеса: проблемы и решения». Мероприятие в таком формате мы проводили впервые: главное отличие от проводимых ранее конференций состоит в том, что оно рассчитано на узкую аудиторию – на специалистов, в чьи обязанности входит организация процесса документирования на производстве.

Проводил вебинар технический директор компании «ПроТекст» Валерий Ледовской. Начал он с краткого обозначения, кто такие технические писатели, каковы их основные обязанности и компетенции. Казалось бы, это самые основы, которые должен знать каждый руководитель – но мы неоднократно сталкивались с обратной ситуацией, поэтому было решено рассмотреть и этот базовый вопрос. Далее Валерий раскрыл следующие важные организационные аспекты: Читать дальше…



Git, Github, управление версиями и вы

19.08.2015

Статья будет полезна тем техническим писателям, кто слышал от разработчиков такие слова, как Github, коммитить, репозиторий, и хочет разобраться, что же это такое, а также тем, кто выбирает такую систему контроля версий для нужд своей компании, чтобы документация к программным продуктам являлась не только теоретически, но и фактически частью этих продуктов, развиваясь совместно с разрабатываемыми программами.


Подумайте о тысячах и тысячах полностью бесплатных и открыто доступных пакетов исходного кода для программного обеспечения профессионального уровня, которые вы можете установить и «ковыряться» с ними на собственном компьютере для развлечения и заработка (помните, условия лицензий отличаются, так что всегда проверяйте их перед установкой). Сложно подсчитать, но на самом деле средний пользователь компьютера имеет прямой доступ к программам стоимостью многие миллионы долларов, если их оценивать старым общепринятым способом. Это верно в любом значении данной фразы. Читать дальше…