Регламент работы технического писателя группы документирования (далее – Регламент) описывает схему процесса документирования и определяет порядок работы технического писателя при создании документации.
TECHWRITER DAYS
Например, гости узнают, как возникло русское стихосложение и почему Александр Пушкин до сих пор считается главным русским поэтом. Посещение экскурсии и музея бесплатное. Любители русской литературы 3 марта могут посетить выставку «Лев Толстой. Гости ВДНХ пог рузятся в атмосферу первой половины XIX века и в интерактивном формате познакомятся с творчеством великого русского писателя.
Экспозиция состоит из 13 тематических разделов. Каждый из них посвящен определенному эпизоду романа-эпопеи «Война и мир». При помощи мультимедийных технологий посетители смогут разучить танцевальные движения, повторяя их за парой на экране, или поиграть в старые карточные игры, а после этого проследить за ходом Бородинского сражения.
В павильоне открыто арт-пространство, где можно посмотреть фильмы о жизни и творчестве Льва Толстого, а также принять участие в литературном вечере и даже создать мультфильм по мотивам произведения. Вход на постоянную выставку свободный. Она работает с 11:00 до 19:00 ежедневно, кроме понедельника.
Великий поэт в культуре Азербайджана». Она посвящена 210-летию со дня рождения классика русской литературы, которое отметят в этом году 15 октября. Поэт неоднократно посещал азербайджанские земли, изучал азербайджанский язык, общался с местной интеллигенцией.
К тому же он дружил с известным азербайджанским писателем, философом и общественным деятелем Мирзой Фатали Ахундовым. В экспозиции представлены интерьеры литературного салона времен первой половины XIX века, а также произведения скульптора Алекс андра Бурганова, пос вященные поэту. Вход по билетам.
Для юных москвичей праздничные мероприятия, посвященные Дню писателя, пройдут в городских библиотеках.
Некоторое время назад решила перечитать всего Достоевского, очень развивает Жаль, что заграницей этого писателя любят намного больше, чем у нас в России. Я не буду показывать и описывать свой день в офисе, он не отличается чем-то интересным. Я сижу весь день уткнувшись в PHP-код, часто с угрюмым лицом, иногда среди тишины раздаются мои возгласы или возгласы программиста. Изредка смех технической поддержки и ооооооочень редко ворчание начальника. Конец рабочего дня официально в 7 вечера, но голова пухнет от компьютера и программного кода, меня ждет друг и я сбегаю из офиса. Время: 25. Мы встретились и решили пойти в Парк Горького, я давно не была и мне все рассказывали, как здорово там сейчас сделали.
А еще я сначала совсем забыла, что нужно фотографировать всё вокруг и вспомнила только на милых уточках: 26. Этой мой друг. Друга зовут Максим. Мы хотели покататься на лодках, но там была огромная очередь! Тогда мы решили пойти на набережную и разузнать, как ходят речные трамвайчики. Пока шли, я увидела судно интересного цвета: 28. Трамвайчик скоро отходил и был полупустой, нам несказанно повезло А еще вокруг нас ходили тучи, но ни капельки не упало, тоже очень удивительно. Памятник Петру Первому.
Если кто-то не знает историю памятника, могу немножко рассказать: изначально это был памятник Колумбу, созданный господином Церетели, который безуспешно предлагал его купить США, Испании и странам Латинской Америки, а они сказали, что им такая какашка такой памятник без надобности. В итоге получилось нечто странное.
На ней речь пойдет о создателях древних книг — монахах-переписчиках. Они не только сохраняли и тиражировали духовные и летописные знания, но и сыграли важную роль в появлении авторских сочинений. Помимо этого, экскурсанты узнают о том, какие сообщения писали друг другу люди на берестяных грамотах. Затем они познакомятся с первыми произведениями русских путешественников, которые назывались хождениями. А еще гостям покажут уникальный памятник русской литературы XVII века — «Житие протопопа Аввакума, им самим написанное». Протопоп Аввакум положил начало такому жанру, как автобиография.
Например, гости узнают, как возникло русское стихосложение и почему Александр Пушкин до сих пор считается главным русским поэтом. Посещение экскурсии и музея бесплатное. Любители русской литературы 3 марта могут посетить выставку «Лев Толстой. Гости ВДНХ пог рузятся в атмосферу первой половины XIX века и в интерактивном формате познакомятся с творчеством великого русского писателя. Экспозиция состоит из 13 тематических разделов. Каждый из них посвящен определенному эпизоду романа-эпопеи «Война и мир». При помощи мультимедийных технологий посетители смогут разучить танцевальные движения, повторяя их за парой на экране, или поиграть в старые карточные игры, а после этого проследить за ходом Бородинского сражения. В павильоне открыто арт-пространство, где можно посмотреть фильмы о жизни и творчестве Льва Толстого, а также принять участие в литературном вечере и даже создать мультфильм по мотивам произведения.
Вход на постоянную выставку свободный. Она работает с 11:00 до 19:00 ежедневно, кроме понедельника. Великий поэт в культуре Азербайджана».
Когда ты единственный техпис в команде разработки, самое сложное — это договориться о новых процессах и показать команде свою ценность. Если удалось найти подход к команде — благодарность за помощь не заставит себя ждать. Приятно наблюдать, как ценность документации и вовлечённость в её написание возрастают. Со временем замечаешь, что на вопросы в рабочих чатах разработчики отвечают ссылкой на документацию. Хорошая новость: чтобы работать техписом в команде разработки, необязательно иметь техническое образование. Достаточно желания разбираться в новом материале и работать с текстами. Личные качества технического писателя В отличие от многих других направлений в IT, в профессии технического писателя личные качества имеют значение. Подготовка технической документации — кропотливая, монотонная работа, требующая усидчивости и внимания к деталям. Это подойдёт не каждому. Дело осложняется тем, что вроде бы полностью интровертивный набор качеств сопровождается требованием к высокой коммуникабельности и стрессоустойчивости, поскольку выяснение деталей у разработчиков и сбор требований к пользователей и сотрудников требует железной выдержки и умения не принимать всё близко к сердцу. Кирилл Наумов руководитель группы документации для разработчиков Ozon Tech Я стал техписом, потому что с детства постоянно читал, в основном русскую классику, и язык мне даётся интуитивно. Всегда любил писать сухие технические тексты и не любил эссе. Даже этот рассказ о себе мне сложно писать. Я отучился год на журфаке, а потом перешел в вышку на менеджмент. Оба образования мне пригодились, потому что со временем я стал лидом. В работе техписа мне нравится упорядочивание — из страшного сумбурного текста делать стройный и понятный. Кроме того, сейчас я параллельно выступаю как бизнес- аналитик для небольшой команды разработки. Опыт техписа там тоже пригодился, потому что приходится много писать требования и другую проектную доку. Можно сказать, что прямо вот пишет технический писатель значительно меньше, чем собирает, анализирует, общается, уточняет. Очень дипломатичная профессия, в общем :- Вопросы, которые могли остаться Разве не лучше, если писать будут разработчики? Нет, не лучше, хотя часто именно так и происходит. Во-первых, это отнимает время разработчика, во-вторых, он не стремится сделать понятно, а пишет на своём языке, в-третьих, многие вещи ему кажутся простыми, понятными и очевидными и он не считает нужным даже упоминать их. Между тем для пользователя такие мелочи могут оказаться дремучим лесом. А если технический писатель ошибся? Документация проходит контроль качества в отделе тестирования, как и весь комплекс программного обеспечения или инженерных решений. Однако всем свойственно ошибаться — и здесь уже компания оценивает критичность ошибки и выстраивает модель безопасности технической документации например, неправильно описанная функция в ERP-системе может не повлечь урон, а вот ошибка в мануале к банковскому или инженерному ПО может стоить слишком дорого. Технический писатель — это технический или писатель?
Оклад: 25000-30000 руб.
Длительность выпуска составляла не более 10-ти минут. Темы сюжетов — события из жизни страны, внутренние и международные общественно-политические процессы. Выходили и специальные выпуски, посвященные очередному съезду КПСС, выборам, праздничным датам, торжественным похоронам видных государственных и политических деятелей.
Использование ПО позволит повысить лояльность пользователей к ИТ-системам, эффективность работы пользователей в ИТ-системах, повысить эффективность процесса разработки и актуализации пользовательской документации и сократить трудозатраты по ИТ-поддержке пользователей. UnaDesk Специализированное программное обеспечение для автоматизированного создания сценариев работы пользователей в ИТ-системах и, на базе этих сценариев, создания учебных материалов, симуляций и документации для пользователей различных ИТ-систем, что позволяет сопровождать пользователя по всем шагам, необходимым для выполнения бизнес-процесса в ИТ-системах Подробнее Российский разработчик системы для быстрого освоения корпоративного ПО HintEd Платформа интерактивного обучения работе в корпоративном ПО. Обучающий слой поверх любого ПО: браузерного, или в виде отдельных Windows-приложений. Экзамус Экзамус разработал технологию, которая анализирует поведение пользователей любых онлайн-сервисов с помощью распознавания лиц и обнаружения эмоций. Для работы с продуктом достаточно наличия у пользователя мобильного устройства или компьютера с веб-камерой.
Умение вести документооборот, знание в области ведения контрактной работы; умение быстро включаться в работу, адекватно воспринимать задачи и выполнять их в указанные сроки; Знание нормативной докуметации по ГОСТ 19, 34 желательно с применением на практике.
Знание серии докуметов ГОСТ 2 желательно с применением на практике. Для работы требуются навыки делового общения как внутри организации, так и с заказчиками и исполнителями работ вне центра; работа в космической отрасли является преимуществом; Желательно обладать базовыми знаниями в области информационных технологий; Самоорганизованность, стрессоустойчивость.
То есть это процессное и ресурсное управление, которым он должен владеть. И это схожие процессы с теми, которые есть у руководителя проекта.
Что из этого следует: техпис может быть правой или левой рукой руководителя проекта и, соответственно, в этом направлении развиваться. Так что хороший техпис может вырасти до РП. Иногда это классическая аналитика при ведении проектов, когда сначала есть общие верхнеуровневые требования, а затем надо проговорить с заказчиком, что сделать — декомпозировать эти требования, провести трассировку, управлять ими. Бывают и неклассические аспекты аналитики.
Например, мы берем проект, которым ранее занимался другой подрядчик. И теперь нам надо его развивать. Стартовая задача технического писателя — это разобраться в этом проекте, провести Reverse engineering технической части проекта: что написано, как это работает. Вторая задача — посмотреть на документы, какие были договоры и технические задания.
И понять, что реально представляет собой проект или конкретный продукт, и соотнести с тем, что написано в документах. То есть это Reverse engineering с прицелом на формальную часть. Сергей Кузьмишкин, руководитель подразделения Nota. Docs Нетипичный случай аналитики также возникает, когда нужно обосновать заказчику стоимость работ в ходе формальных процедур по подготовке к конкурсу.
И тут надо понять детали реализации — сходить к разработчикам, понять, что они реализовали, и каким образом эта функциональность работает. Если разработчики еще не реализовали, то идти к продактам, которые развивают данную часть продукта, и узнавать, что они задумывали и сделали. Все это нужно оформить и защитить перед заказчиком, иногда вплоть до демонстрации кода продукта. Поэтому технический писатель может вырасти в аналитика.
В крупных контрактах, как коммерческих, так и государственных, есть правила привлечения генподрядчиком субподрядчиков: на какие работы их можно привлечь, на какие нет, на какие работы нужно привлечь обязательно. Типичный пример — если на проекте выполняются работы по информационной безопасности, то они требуют наличия лицензий, которых у генподрядчика может не быть. Если привлечь субподрядчика, не выполняя обязательные шаги по контракту, то генподрядчик не сдаст проект. То есть эта зона роста — на стыке IT и юриспруденции.
У нас в Notamedia есть кейс с сотрудником, который ранее работал на стороне заказчика и занимался проверкой формальной стороны договоров. Типичный подводный камень в договоре — исполнитель должен уведомить заказчика за 5 дней до проведения испытаний о том, что он к ним готов. И если он этого не сделал — начинаются проблемы. И этот сотрудник обладает способностью быстро вычитывать договоры, сразу подмечая места в документе, где могут возникнуть проблемы.
Это полезно, так как РП тяжело погружаться в эти юридические тонкости. И здесь задача технического писателя — прикрывать РП по формальной части. Вертикальный рост технического писателя Вертикальный рост технического писателя прост и понятен. В подразделении Nota.
Docs четко выстроена градация между специалистами уровня Junior, Middle и Senior: Junior — новичок, обладающий базовыми компетенциями: грамотность, владение MS Office, системность и структурированность мышления, внимательность к деталям. Но ему нужна помощь от более опытных коллег по ряду вопросов.
Яндекс Образование
В 2023 году акция «День с писателем» посвящена 200-летию со дня рождения русского драматурга и писателя Александра Николаевича Островского. 25 апреля 2024 года в Большом выставочном зале Российской государственной детской библиотеки открылась выставка иллюстраций «С красной строки» к 100-летию со дня рождения писателя Анатолия Васильевича Митяева. технические характеристики mitsubishi galant 25 i vr-4 type-v 4wd. Опыт работы в качестве технического писателя в области разработки и внедрения информационных систем от 3х лет.
С Днем технического писателя!
Полчаса смеялся, когда некая hbnf назначила (в философтовском форуме) 1 апреля Днем технического писателя. Опыт работы в должности бизнес-аналитика или технического писателя от 1 года. найм технических директоров, что бизнес ждёт от человека на позиции директора и какими глазами смотрит на соискателя. Должность: технический писатель, хотя в последнее время скорее knowledge manager. Официально считается, что профессия технического писателя возникла после Второй мировой войны, а свое развитие получило с изобретением компьютера.
День технического специалиста на PulpFor 2023
И любое высшее образование научит добывать, отбирать и структурировать информацию, критически мыслить и быстро ориентироваться. Есть и базовый набор умений, которые не зависят от образования, но сильно упростят техпису жизнь: Грамотность. Теоретически неграмотный технический писатель может существовать, но ему будет нелегко. Конечно, при вычитке все ошибки найдутся и исправятся, но важно самостоятельно уметь превращать свои мысли в грамотные предложения. Техпис постоянно общается с разными людьми. С кем-то это легко и просто, а из кого-то информацию нужно добывать. Сложно представить на месте технического писателя интроверта, которого приводит в ужас мысль, что надо разговаривать. Например, заказчик говорит, что ему нужна документация. У него есть макеты в «Фигме» и примерный флоу процесса. Выглядит так, будто для полноценной документации этого недостаточно. Но есть ещё хранитель знаний, которому, например, некогда эти знания превращать в текст.
Тогда техпис собирает все возможные вопросы и идёт к хранителю выведывать информацию. Хранителем может быть любой человек из команды: разработчик, продакт, аналитик, юрист, дизайнер, кто угодно. Марина Вашак, технический писатель Умение писать коротко и по делу. Технический текст должен быть сухим, без лишних расшаркиваний. Техпис не гонится за количеством слов — наоборот, снимает с текста все «украшения»: обособленные обороты, составные глаголы, отглагольные существительные и прочую мишуру. Адекватное восприятие критики. Работа технического писателя — процесс творческий, поэтому надо быть готовым к замечаниям. Они будут всегда, потому что даже самый крутой специалист — человек, а люди ошибаются. Если полагаться только на своё мнение, есть шанс написать инструкцию, которую сможет понять только автор. Адекватная обратная связь.
В дополнение к предыдущему пункту: технический писатель — это не только писатель, но и читатель. У разработчиков есть код-ревью. У технических писателей, если их больше одного, в идеальном мире есть ревью текстов. Потому что, опять же, все ошибаются, глаз замыливается, а две головы всегда лучше одной. И если нужно вычитать текст и дать обратную связь, понадобится много эмпатии и заинтересованности в общем результате, а не высокомерное «всё фигня, переделывай». Как понять, что работа мне подходит Возьмите приложение любимого банка и напишите инструкцию к какому-то простому процессу. Например, как оплатить мобильную связь.
Во многом тексты Олега Рябова автобиографичны — в них есть близкие ему люди и места. Так и новый роман автора — "Позови меня, Ветлуга" о зове Родины, на который откликаются герои — пусть даже неосознанно. Так, по мнению Олега Рябова, хороший писатель должен, в первую очередь, писать. Во-вторых, писать надо правдиво. И еще один важный момент — автор должен быть в курсе литературного процесса, знать мастеров прошлого и будущего.
Первым лауреатом Нобелевской премии по литературе стал в 1901 году французский поэт и эссеист Сюлли-Прюдом. В 2015 году ее лауреатом стала советская и белорусская писательница, журналистка Светлана Алексиевич. Дублинская литературная премия — наиболее престижная литературная премия в мире. Ее размер — 100 тысяч евро. Она вручается ежегодно с 1996 года за лучшее прозаическое произведение на английском языке. Наиболее экранизируемым писателям является Эдгар По. Сюжеты произведений этого американского писателя вошли в 114 кинофильмов. В Великобритании писательница Агата Кристи считается одним из символов страны и почитается наравне с королевой. Тираж ее произведений уступает только Шекспиру и Библии.
З марта отмечается Всемирный день писателя03. Первый текст вышел из-под пера Олега Рябов, когда автору было 20 лет, с тех пор — он продолжает писать — как прозу, так и поэзию. Творит он всегда по особому расписанию. Олег Рябов - писатель, главный редактор журнала "Нижний Новгород", член союза писателей России: «Я пишу всегда утром, встаю рано, в 5-6, и вот 2-3 часа для меня наиболее плодотворные, очень долго входишь в канву, в тему, в тело того текста, который был написан в предыдущие дни и недели. Читаешь, что-то какие то запятые там исправляешь, меняешь абзацы какие-то и вот когда туда уже полностью входишь, вдруг начинает вырисовываться что же будет дальше».
День из жизни технического писателя в Алматы с зарплатой около 440 000 ₽
В Кургане ожидается спад уровня воды в Тоболе до 30 см в течение 1-2 дней. Один день технического писателя. Здравствуйте! С вами опять Татьяна, переводчик и технический писатель из Торонто. К Всемирному дню писателя редакция портала «Российское образование» вспомнила интересные факты о писателе, который считается и русским, и американским. Новости дня читайте на Взгляде. 165 лет со дня рождения русского учёного, писателя. Константина Эдуардовича Циолковского (1857-1935) День работника дошкольного образования.
Кто такие технические писатели и зачем они нужны в команде
Первые тексты, вспоминает Олег Рябов, писал на чистом энтузиазме. Сейчас он уверен - писательство — занятие для личности зрелой, уже нажившей определенный опыт. В своих книгах и стихах Олег выделяет несколько основных тем, но главная — тема Родины. А родина Олега Рябова — Нижний Новгород. Олег Рябов - писатель, главный редактор журнала "Нижний Новгород", член Союза писателей России: «Это основная тема для меня.
Уже не помню, почему так случилось, помню только как мне было страшно и стыдно рассказывать об этом дома :scream: Когда приходила исправлять, учительница всё приговаривала: ну как же так, ты же умная девочка, неужели не вспомнила вот это правило? Часто писала по 6-7 страниц текста, а не сделать ошибок в таких длинных текстах сложно". Вообще, отношения с ней были слегка натянутыми. А с русским и литературой, наоборот.
Participation of company employees in the conference serves as a form of continuous learning. Employees can enhance their knowledge and skills, which, in turn, can improve the quality and efficiency of technical documentation creation. Experience Sharing and Networking. The conference offers a unique opportunity to exchange experiences with colleagues from other companies. This can help expand the professional network, discover new ideas and solutions, and establish potential partnerships. Enhancing Company Visibility. Company participation as a conference partner can increase visibility and the dissemination of information about its products and services. It can also attract the attention of potential customers and partners. Receiving Feedback. Companies can utilize conference opportunities to receive feedback from technical writers and other participants regarding the quality of their documentation. This enables improvements in product documentation and meets customer needs. Fostering a Culture of Learning and Innovation.
Присоединяйтесь к нам всей компанией, но по возможности с одного компьютера, чтобы оставить больше свободных мест! Первый сбор На первый Доквариум мы приглашаем вас в четверг 28 июля, в 16:00 по московскому времени. Ориентировочно мероприятие займёт 2 часа. Тема: «Инструменты технического писателя». Анастасия подготовила доклад «Создаём документацию с удовольствием в MadCap Flare», в котором она поделится своим многолетним опытом работы в MadCap Flare, а вы сможете задать ей любые вопросы. Кстати, недавно в нашем блоге была статья Анастасии на эту тему. Далее технический директор компании «ПроТекст» Валерий Ледовской расскажет о средствах нашей работы: «Инструменты компании ПроТекст при выполнении задач технического перевода и локализации на аутсорсинге». Затем нам хотелось бы послушать рассказы самих участников об использовании разных инструментов, кроме самого распространённого варианта — Microsoft Word. Хотя если вы используете его каким-то необычным образом, мы тоже с удовольствием узнаем и о вашей практике! Готовьте рассказы, придумывайте вопросы для обсуждения, ибо круглый стол — это место для общения. Приходите рассказывать и спрашивать, говорить и спорить, а не только слушать!
Обязанности технического писателя
Только так получится хорошая и качественная документация. Один в поле не воин Часто думают, что технический писатель — это профессия, не требующая особых коммуникативных навыков. На практике оказывается, что для написания документации каждый день приходится консультироваться со множеством коллег: бизнес-аналитиками, разработчиками, тестировщиками. Бывает так, что в исходных документах авторы что-то опускают, что-то недоговаривают. Работа писателя — быть профессиональным занудой: уточнять, переспрашивать, перепроверять информацию много раз, чтобы правильно всё описать и не допустить ошибку в документе. Бывают случаи, когда писатели находят ошибки в реализации. Писатель выполняет свою работу на самом последнем рубеже перед отгрузкой системы и документации заказчику. На поверку становись! Когда писатель завершает работу над документом, он обязательно отправляет его на проверку.
Документацию проверяют бизнес-аналитики, разработчики, тестировщики. Это очень важный этап, ведь писатель всегда может ошибиться — что-то неправильно понять, не учесть каких-то незадокументированных особенностей реализации. Ещё наши документы проверяет наш профессиональный технический редактор. Он исправляет орфографические и грамматические ошибки, подчищает описки, следит за смысловой и логической чистотой документа, проверяет соблюдение руководства по стилю. Это руководство — наш маленький внутренний стандарт. В нём записаны разрешённые и запрещённые термины, правила оформления документов разных типов, приведены наиболее часто используемые фразы, конструкции и обороты. Руководство по стилю помогает нам писать документацию по общим для всех писателей правилам: единство стиля — прежде всего. В воображении читателя должен возникнуть собирательный образ одного крутого профессионала — писателя, который создаёт разные документы или разделы.
Праздник труда Работа технического писателя не такая однообразная, как может показаться со стороны. Мы пишем очень разные документы — у нас есть и справочники с большими таблицами параметров или полей БД. Есть руководства пользователя с подробным описанием каждой кнопки интерфейса. Есть руководства администратора со множеством технических подробностей о работе и установке системы. Но самый сложный, и при этом самый интересный, тип документа — это руководство по настройке. В нём комплексно описывается реализация определённого решения в разных системах и подробно объясняется что и где нужно настроить, чтобы это решение заработало. Писателю приходится писать разные типы документов — сегодня часами описывать один за другим параметры системы, а завтра думать над тем, как понятнее и проще описать алгоритм работы решения в руководстве по настройке. Но в любом случае писатель должен быть внимательным, аккуратным и педантичным.
Клиент всегда прав — отгрузка до 23. Документы на систему мы отгружаем одновременно с передачей готовой системы. Новые версии ранее отгруженных документов мы, по сложившейся традиции, передаём в пятницу. Документацию мы пока отгружаем в формате PDF — вместе с новой версией системы заказчик получает пакет файлов. Их можно скачать на специальном портале, где каждому заказчику доступна документация по тем системам и их версиям, которые у него установлены. Кстати, нашей документацией пользуются не только заказчики: многие сотрудники компании Bercut тоже обращаются к нашим документам, чтобы разобраться в каком-то сложном вопросе по функционированию той или иной системы. Большие надежды — портал bercut.
Всегда любил писать сухие технические тексты и не любил эссе. Даже этот рассказ о себе мне сложно писать. Я отучился год на журфаке, а потом перешел в вышку на менеджмент. Оба образования мне пригодились, потому что со временем я стал лидом. В работе техписа мне нравится упорядочивание — из страшного сумбурного текста делать стройный и понятный. Кроме того, сейчас я параллельно выступаю как бизнес- аналитик для небольшой команды разработки. Опыт техписа там тоже пригодился, потому что приходится много писать требования и другую проектную доку. Можно сказать, что прямо вот пишет технический писатель значительно меньше, чем собирает, анализирует, общается, уточняет. Очень дипломатичная профессия, в общем :- Вопросы, которые могли остаться Разве не лучше, если писать будут разработчики? Нет, не лучше, хотя часто именно так и происходит. Во-первых, это отнимает время разработчика, во-вторых, он не стремится сделать понятно, а пишет на своём языке, в-третьих, многие вещи ему кажутся простыми, понятными и очевидными и он не считает нужным даже упоминать их. Между тем для пользователя такие мелочи могут оказаться дремучим лесом. А если технический писатель ошибся? Документация проходит контроль качества в отделе тестирования, как и весь комплекс программного обеспечения или инженерных решений. Однако всем свойственно ошибаться — и здесь уже компания оценивает критичность ошибки и выстраивает модель безопасности технической документации например, неправильно описанная функция в ERP-системе может не повлечь урон, а вот ошибка в мануале к банковскому или инженерному ПО может стоить слишком дорого. Технический писатель — это технический или писатель? И то и другое, поскольку это взаимодополняющие качества, делающие специалиста уникальным. Думается, что технические писатели — это одни из тех, кого долгое время не смогут заменить даже самые умные нейронки, поскольку за выдачей контента стоит огромная синтетическая и аналитическая работа, основанная на знании ПО, архитектуры и процессов. ИИ это не под силу. Каков путь развития? Можно вырасти в тимлида техписов, можно уйти в управление, при желании явно видится переход в аналитику, тестирование, поддержку, разработку. Всё зависит от желания и уровня навыков. К слову, технические писатели довольно неплохо зарабатывают сеньоры могут получать даже около 250 тыс. Что там с копирайтерами? Копирайтер пишет разные тексты для нужд компании: hr, pr, рассылки, реклама, буклеты, тезисы, статьи и многое другое. UX-писатель редкий зверь во многих IT-компаниях — сочетает в себе навыки копирайтера и дизайнера. Более динамичный специалист, который пишет тексты для интерфейса.
Руководители проектов. С РП технический писатель взаимодействует для координации и контроля над соблюдением всех необходимых формальностей со стороны участников проекта. Обеспечивает консистентность формальной части проекта. Цели работы технического писателя Работа в сфере заказной разработки — это командный вид спорта, поэтому цель работы технического писателя — это успех всей команды, всего проекта. Антицель — написать красивый документ по ГОСТу, по которому невозможно провести испытания демонстрацию продукта заказчику , либо который не коррелируется с разработанной функциональностью продукта. Поэтому технический писатель разрабатывает документацию для целей, которые должны совпадать с целями компании. Если он пишет отчетную документацию по конкретному проекту, то он должен тесно взаимодействовать с проектной командой и осознавать, что разработанная функциональность будет приниматься заказчиком именно на основе написанной им отчетной документации. А ошибки в отчетной документации приводят к провалу испытаний или вовсе к отказу в приемке работ. Для технического писателя важно не зацикливаться на самом тексте, а смотреть в суть. Прийти к разработчику и спросить: «Все ли я правильно понял и написал? Еще один важный момент — технический писатель должен не только предоставить заказчику комплект отчетной документации, но и согласовать ее с ним. Если клиенту что-то не нравится — выяснить, что именно, и понять, как это исправить. Куда расти техническому писателю Представим ситуацию, что человек приходит на позицию технического писателя, перерастает грейд Junior и в какой-то момент начинает думать: «А куда дальше развиваться? Буду ли я до конца карьеры писать технические документы, такие как руководство пользователя? У технического писателя есть конкретные зоны роста — как горизонтального, так и вертикального. Поговорим о горизонтальном росте подробнее. Хороший технический писатель должен знать, какие шаги нужно пройти для успешной сдачи проекта. Это шаги, которые находятся не только в его компетенции, но и которые должны пройти другие участники команды: дизайнеры — нарисовать макеты, разработчики — написать код, аналитики — описать бизнес-процессы. И контроль выполнения работ другими участниками команды тоже может быть в числе обязанностей техписа. Также техпис должен уметь оценивать затраты на разработку той или иной документации: Сначала сформулировать требования к другим участникам команды — в каком виде и в какие сроки ему должны предоставить исходные данные для формирования комплекта отчетной документации. С учетом качества и количества исходных данных прикинуть свои трудозатраты на формирование отчетной документации. Уложить это все на план-график исполнения контракта, понять, сколько нужно людей, какой трек согласования документации, и как вообще при этом выжить. То есть это процессное и ресурсное управление, которым он должен владеть. И это схожие процессы с теми, которые есть у руководителя проекта. Что из этого следует: техпис может быть правой или левой рукой руководителя проекта и, соответственно, в этом направлении развиваться. Так что хороший техпис может вырасти до РП. Иногда это классическая аналитика при ведении проектов, когда сначала есть общие верхнеуровневые требования, а затем надо проговорить с заказчиком, что сделать — декомпозировать эти требования, провести трассировку, управлять ими. Бывают и неклассические аспекты аналитики. Например, мы берем проект, которым ранее занимался другой подрядчик. И теперь нам надо его развивать. Стартовая задача технического писателя — это разобраться в этом проекте, провести Reverse engineering технической части проекта: что написано, как это работает. Вторая задача — посмотреть на документы, какие были договоры и технические задания.
После летучки возвращаюсь на рабочее место. Сегодня мне нужно описать работу новой программы. Список отбираемых работ берется не наобум. Ежедневно никто не станет напоминать, что тебе нужно описать. Процессом планирования занимается сам технический писатель: пересматривает документы отделов разработки что сделали, как это работает , открывает тестовые разработанные программы смотрит и вручную проверяет их работу. И из всей полученной информации выбирает только то, что влияет на документацию. Теперь я создаю документ, в котором буду разрабатывать описание программы. Перед началом описания необходимо изучить функционал. То, как вы поймете его изначально, повлияет на качество текста в целом. Чтобы посмотреть, как работает программа, запрашиваю ее в отделе разработки. Для начала в документе создаем примерную структуру — в какой книге будет располагаться новый текст, какие разделы появятся, что они будут в себя включать. Книги обычно подразделяются на руководства для пользователя, администратора и разработчика. В зависимости от этого, описание выполняется на языке, понятном представителю одной из ролей. Например, для пользователя нужно писать «простым» языком, давать подробный порядок действий, для разработчика, напротив, нужны четкие формулировки с терминами, описание рабочих примеров кода. Вам сложно понять, что нужно писать, с чего начинать, как писать? Не переживайте. Для каждого типа описываемого объекта, например, справочник, сценарий или установка, имеется отдельный формат описания.