Найти тему
Закреплено автором
Клуб технических писателей
Приветствую всех на своем канале! Здесь вы найдете уникальные материалы про профессию технический писатель и техническое документирование. Мало кто так откровенен на эту тему, как я ) Откуда я беру эти материалы? Из головы: всё, о чем я здесь пишу - моя жизнь, мой личный опыт. Немного юридической информации: все материалы канала защищены законом РФ об авторском праве. Нарушением авторских прав считается несанкционированное автором копирование, тиражирование, публичное озвучивание в интернете (например, если это авторский обучающий курс), перевод на другие языки и пр. За нарушение авторских прав в отечественном законодательстве предусмотрено три вида ответственности: гражданско-правовая, уголовная, административная.
2 года назад
Как сделать универсальный, надежный шаблон документа MS Word и никогда не иметь с ним никаких проблем
В этой статье будут описаны распространённые ошибки форматирования документа MS Word с помощью стилей и приведён проверенный метод создания надёжных шаблонов, основанных на стилях. Этот метод никогда меня не подводил на протяжении уже более 10 лет. Те шаблоны, которые были созданы много лет назад в более старых версиях MS Word при помощи такого метода, так же хорошо работают и в новейших версиях этого текстового редактора. Итак, когда мы пытаемся привести в порядок текстовый документ, используя стили,...
1 месяц назад
Как сократить трудозатраты техническому писателю
В статье будет несколько советов, как можно пересмотреть свой рабочий процесс техническому писателю, чтобы поменьше работать. Сразу сделаю оговорку, что это не "волшебная таблетка". Нужно будет подумать, поработать над собой, возможно, разделить оптимизацию на несколько этапов и только после этого будет вам счастье. Можно будет либо делать больший объем работы за то же время и, соответственно, зарабатывать больше, либо будет больше времени на личную жизнь. Итак, почему одну и ту же работу один человек...
9 месяцев назад
Профессионализмы технических писателей: "собрать справку"
Справка здесь - не бумажка с подписью и печатью, а справочные материалы на какую-либо тему. Собрать - не значит побегать по офису или улице и пособирать что-то, а скомплектовать справочные материалы в формат, который потом будет опубликован. "Собрать справку" - один из самых распространенных профессиональных терминов у технических писателей. Почему? Потому что большинство из нас работает именно со справочными материалами на ту или иную тему. Итак, какую именно работу подразумевает термин "собрать справку": 1...
1 год назад
Пояснительная записка по ГОСТ
По какому принципу делается любая пояснительная записка, какая информация там должна быть, где ее взять - было здесь. Теперь разберемся, как уложить добытую информацию в документ: как организовать структуру документа в зависимости от того, для какого объекта делается пояснительная записка. Для этого мы будем использовать требования Российских стандартов. Существует несколько систем ГОСТ, в которых приведены требования к пояснительным запискам: 1. Пояснительная записка программы делается в соответствии с единой системой программной документации (ГОСТ 19, ЕСПД)...
580 читали · 1 год назад
Как приручить многоуровневые списки в MS Word
Все, кто занимается оформлением документов, сталкивается с тем, что автоматическая нумерация списков порой выкидывает сюрпризы. И совершенно непонятно, как это исправить, поведение списков порой кажется непредсказуемым. Так происходит из-за недопонимания того, как работают списки и в принципе, MS Word. В этой статье будет инструкция, как правильно работать с многоуровневыми списками, чтобы они не выдавали сюрпризов, на примере автоматической нумерации заголовков разделов и подразделов. Такую сквозную нумерацию можно сделать при помощи стилей и многоуровневого списка...
5197 читали · 1 год назад
Как писать пояснительную записку к проекту
В этой статье я расскажу, как техническому писателю сделать один из основных проектных документов - пояснительную записку. Для того, чтобы сделать хороший документ, нужно понимать, о чем этот документ должен быть. Основное назначение пояснительной записки - описать проектируемый объект в целом: кратко о том, какой он должен быть и подробно о том, как это будет достигнуто. Выделим то, что должно быть именно в пояснительной записке любого вида проекта: Такое разделение документа на две части - логическое...
1856 читали · 1 год назад
Здравствуйте, я на собеседование
или как проходят собеседования на вакансию "Технический писатель". Побывав на нескольких таких собеседованиях, могу выделить общие моменты, которые происходят независимо от специфики компании. Не будем уделять внимание той части, где задает вопросы HR-специалист. В данном контексте это неинтересно. Начнем сразу с момента, где происходит уже следующая часть отбора кандидатов на вакансию - общение с руководителем подразделения, в которое ищут специалиста. Во время такого общения либо дают задание,...
694 читали · 2 года назад
Основные надписи: что? где? когда?
О том, что в проектной документации внизу листа есть такие прямоугольные таблички, где что-то написано, знают все. Эти таблички (в простонародии - "штампы", по-научному - "основные надписи") отчасти и делают документацию проектной. А о том, откуда взялись эти штампы, почему они именно такие, почему в разных документах эти штампы выглядят по-разному, знают только те, кто потратил время и разобрался в этом. Как часто бывает в проектных организациях: более опытный товарищ делится с менее опытным шаблоном, в котором есть форматки (заготовки под все размеры листов с штампами)...
203 читали · 2 года назад
Как разобраться в ГОСТ по документированию
В этой статье разберемся, как устроены Российские ГОСТ по документированию. Зачем и когда это может пригодиться? В основном, по ГОСТ документируются государственные проекты, либо проекты, подлежащие обязательному согласованию с надзорными органами РФ (строительные, пожаро- и взрыво-опасные и пр.). ГОСТ разделены на системы. Первая цифра в номере ГОСТ означает систему, к которой он относится. В РФ существуют следующие системы ГОСТ по документированию: 2 - Единая система конструкторской документации...
183 читали · 2 года назад
Преимущества и недостатки профессии "технический писатель"
Проработав техническим писателем несколько лет, могу сделать некоторые выводы по поводу того, насколько хороша или плоха такая работа. Итак, я думаю, вам интересно будет узнать в первую очередь, что мне не нравится в этой профессии: 1. Мне не нравится, как эта профессия влияет на личность. Ты изо дня в день превращаешься в душнилу - педанта, начинаешь чаще замечать ошибки в правописании, пунктуации, коряво построенные фразы. И самая печальная стадия этого процесса - когда ты не только замечаешь, но еще и поправляешь окружающих...
415 читали · 2 года назад
7 важных правил технического писателя
1. В документе не должно быть ничего лишнего, только по делу и по теме. 2. Технический писатель в большинстве случаев не должен глубоко разбираться в том, о чем пишет, для этого есть профильные специалисты. 3. Технический писатель должен знать, как сделать хороший документ: как структурировать информацию и преподнести ее на языке, понятном целевой аудитории. 4. Технический писатель должен иметь широкий кругозор в той сфере, в которой пишет документы...
2 года назад
Не скучно ли работать техническим писателем?
Бытует мнение, что "бумажная работа" или "работа с документами", которой занимаются технические писатели - скучная. Многие при этих фразах представляют работу по перекладыванию бумаг из одной стопки в другую, скучные и длинные рабочие дни, проведенные в обнимку с документацией. Что на самом деле? На самом деле, все также, как и во всех остальных профессиях, связанных с умственным трудом. К примеру, у программистов или разработчиков чего-либо работа не веселее, тоже много рутины и эту работу также можно назвать скучной, особенно, когда только начинаешь во всем разбираться...
2 года назад