Разработка технической документации и технические писатели Технические писатели и разработка технической документации технические писатели в Телеграм 

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1 2 След.
RSS
Переквалификация в техписы. Нужна помощь
 
Всем жителям форума привет. Начну свой рассказ с того, что на данный момент я работаю в фирме, которая занимается вентиляцией. Работаю руками, кручу отверткой, собираю, настраиваю и тд. Учусь в институте на ИТишника.Почти 4й курс.  В фирме открылась вакансия техписа. Есть небольшой(мизерный) шанс занять ее. Основная, как я понимаю работа - это паспорта к модулям управления вентиляцией. У нас конечно же есть они, но не по гостам.
Хотелось бы помощи и напутствий получить) К начальству надо идти с чем-то, т.е. с примером твоего труда, дабы хоть как-то заинтересовать.
Поэтому подскажите. Как же сделать этот паспорт правильно? какие госты нужны и как все оформлять,используя их, какие нормы по оформлению и тд. ?
 
МЕЖГОСУДАРСТВЕННЫЙ СТАНДАРТ. ЕДИНАЯ СИСТЕМА КОНСТРУКТОРСКОЙ ДОКУМЕНТАЦИИ смотри в эту сторону и сюда ГОСТ 2.601-95 Эксплуатационные документы
 
вот здесь http://techwriters.ru/forum/viewtopic.php?f=28&t=915&sid=5642a6efccd04945d7419bf72377e3e8 скачайте шаблон "Паспорт изделия" и делайте по образцу или найдите ГОСТ по которому делается паспорт изделия
 
спасибо за полезную информацию.
А в шаблоне там все учтено? а то вроде же и шрифт по гостам должен быть и прочее.
 
Насчет шрифтов не знаю, по ГОСТам не пишу. Мой совет возмите ГОСТ на "Паспорт изделия" и делайте все строго по нему.
 
Цитата
Хотелось бы помощи и напутствий получить) К начальству надо идти с чем-то, т.е. с примером твоего труда, дабы хоть как-то заинтересовать.
Поэтому подскажите. Как же сделать этот паспорт правильно? какие госты нужны и как все оформлять,используя их, какие нормы по оформлению и тд. ?
Про ГОСТ вам уже посоветовали, добавить нечего :) Я бы хотел позанудствовать и обратить ваше внимание на другую сторону профессии. Я все понимаю: форум, неформальное общение, спешка и т. п. Но... к русскому языку стоит относиться бережнее :) Если инструкция будет составлена на таком же русском, как и ваши посты на форуме, то заинтересовать начальство вряд ли получится. Если это начальство, конечно, вменяемое :)
 
Я уже вообще думаю, что для технического писателя самое главное - граммотность! (школьная программа, увы, забывается легко). Как советует Orge  обратитите на это внимание, иначе написание текстов превратится в тяжкий труд.
 
Цитата
Я уже вообще думаю, что для технического писателя самое главное - граммотность!
Не совсем так :) Граммотность -- желательное, но не обязательное условие. Во-первых, как идеальный вариант, доки должен вычитывать корректор и\или научный редактор. Во-вторых, если, изучив доку, у пользователя (администратора, оператора, инженера по внедрению и т. п.) не остается никаких вопросов по использованию, администрированию продукта (после прочтения он садится и начинает работать с продуктом, не доставая техподдержку и т. п.), то на запятые и опенчатки мало кто станет обращать внимание.
Граммотность, в данном случае, превратится, скорее, в вопрос имиджа. У компании, которая хочет позиционировать себя, как ведущего игрока на рынке, все должно быть прекрасно. В том числе и прекрасные запятые на нужном месте. В этом случае, если техпис на самом деле пишет кайфовые доки, но допускает ошибки, уверен, что он останется на своем месте, а компания воспользуется вариантом за номером 1.
Ох что-то меня несет после работы, ой несет )) Прошу прощения )
 
Матушки!!! Грамотность, то пишется с одной М!!! Вот мы и научим начинающего техписа!! :oops:
 
Цитата
Во-первых, как идеальный вариант, доки должен вычитывать корректор и\или научный редактор
Вот я за это двумя руками! Ну не может один человек написать книгу без единой ошибки!
 
Цитата
Вот я за это двумя руками! Ну не может один человек написать книгу без единой ошибки!
А вдруг может? Есть вспомогательные инструменты для этого. Если компания маленькая или того хуже, писатель - фрилансер, то на помощь приходят словари. Например MSWord оснащен нормальным словарем для проверки орфографии. Да много инструментов всяких. Вопрос в цене и необходимости.

Главное  исправить [i:2ofj4jq3]оЧЕПЯтки[/i:2ofj4jq3] и наиболее распространенные обороты со знаками препинания. Не думаю, что каждый второй пользователь, который может прочитать РП будет преподом русского языка.

Даже если нет уверенности как правильно расставлять знаки в списках, называть Пользователя с прописной или строчной буквы или редактировать заголовки ну и всякое такое - [b:2ofj4jq3]главное делать однообразно[/b:2ofj4jq3]. Тогда это сойдет за "корпоративный стиль". :-)
 
сравнимых масштабов беда что и у _Alexandr_.
успела поработать и с чертежами и с различной документацией, но вот тех. писателем себя назвать все же не рискну. но потом поставили задачу сочинить документацию так, "чтобы и в пдф сохранить, и на сайт выложить, и анимация была". пробую подступиться к этому заданию. немного подумав, решила пользоваться xml-редактором и публикациями. и все вроде бы потихоньку помаленьку становится понятно, но вот такие задачи, как ,например, вставить формулу ставят в тупик.
 
Цитата
Марья пишет:
но вот такие задачи, как ,например, вставить формулу ставят в тупик.
Я вставлял формулы изображениями, делаешь в Word,  потом снимок экрана и вставляешь в документ
 
да, изображениями тоже хороший вариант, но качество отображения хромает, конечно. попробовала написать формулу в редакторе MathML, и уже ее, формулы, код списывать в XML файл, подсмотрев примеры. для DocBook получилось, для DITA пока не очень.
Кстати, кто то может поделиться опытом, с чем мне лучше работать для решения поставленной задачи ("чтобы и в пдф сохранить, и на сайт выложить, и анимация была"), с DITA или DocBook?
 
Цитата
Марья пишет:
Кстати, кто то может поделиться опытом, с чем мне лучше работать для решения поставленной задачи ("чтобы и в пдф сохранить, и на сайт выложить, и анимация была" ;) , с DITA или DocBook?
Это скорее личные предпочтения. Dita активно развивается, а Docbook устаревает.
 
Спасибо, буду осваивать DITA. Теперь у меня хотя бы направление действий есть.
 
Доброго времени суток, Уважаемые!
Гуляя по форуму наткнулся на эту тему. Не могло не вызвать улыбку описание вставки формул в графическом виде или подстановки xml-кода.  :)  Работаю тех. писателем пару лет, однако, таких проблем не возникало никогда. Про DITA слышал, тем не менее, ни разу на нее не заглядывался. Использую только H&M (в настоящее время 6.2.3). Создал репозитории со структурой для любых! возможных документов, нарисовал pdf-шаблоны под 34 и 19 ГОСТ, сделал текстовые сниппеты для листов утверждения, файлы для импорта необходимых переменных ФИО и автоматических счетчиков рисунков и таблиц, сделал парочку шаблонов для сайтов с анимацией и импорт-проекты для всплывающих окон на js и т.д.
Работать просто и легко, исполняются любые прихоти заказчиков (это ни в коем случае не реклама, а совет новичкам). А для вставки формул используется OLE-объект MS Equation 3.0  :)
 
Доброго времени ГОСТЬ! H&M достойный инструмент, но в отличии от DITA он лишен многопользовательского режима работы, для небольших компаний H&M  самое то. Если вы хороший специалист в этом направлении были бы очень рады вашим советам и рекомендациям на форуме Help Manual
 
Цитата
Гость пишет:
Доброго времени суток, Уважаемые!
Гуляя по форуму наткнулся на эту тему. Не могло не вызвать улыбку описание вставки формул в графическом виде или подстановки xml-кода.  :)  Работаю тех. писателем пару лет, однако, таких проблем не возникало никогда. Про DITA слышал, тем не менее, ни разу на нее не заглядывался. Использую только H&M (в настоящее время 6.2.3). Создал репозитории со структурой для любых! возможных документов, нарисовал pdf-шаблоны под 34 и 19 ГОСТ, сделал текстовые сниппеты для листов утверждения, файлы для импорта необходимых переменных ФИО и автоматических счетчиков рисунков и таблиц, сделал парочку шаблонов для сайтов с анимацией и импорт-проекты для всплывающих окон на js и т.д.
Работать просто и легко, исполняются любые прихоти заказчиков (это ни в коем случае не реклама, а совет новичкам). А для вставки формул используется OLE-объект MS Equation 3.0  :)
Последние версии H&M не поддерживают ссылок на кириллице. Поэтому нам приходится использовать H&Mверсии 5. Как вам удается решить эту проблему?
Если у вас появятся вопросы, пожалуйста, обращайтесь - будем думать вместе!
 
Цитата
Alex_Gur пишет:
Последние версии H&M не поддерживают ссылок на кириллице
А какие именно ссылки? (топик-линки, url, mail, js... )
 
Цитата
H&M User пишет:
Цитата
Alex_Gur пишет:
Последние версии H&M не поддерживают ссылок на кириллице
А какие именно ссылки? (топик-линки, url, mail, js... )
Кажется, топик-линки. Мы в основном используем их.
И внутренние ссылки (ссылки на другие топики внутри файла).
Если у вас появятся вопросы, пожалуйста, обращайтесь - будем думать вместе!
 
Цитата
Alex_Gur пишет:
Кажется, топик-линки. Мы в основном используем их.
И внутренние ссылки (ссылки на другие топики внутри файла).
Тогда понятно, откуда у Вас в топик-линках берется кириллица. Именуете Topic ID по-русски? Представляете, если одновременно несколько писателей работают с одним проектом в H&M, то какая каша получается? Ссылки идут по Topic ID, а они не должны быть на кириллице - гораздо проще их обозвать 1, 1.3.1 или Topic1-2, чтобы облегчить сборку комплексного или сетевого проекта и даже ради сохранения сортировки в списке Target при вставке линка. Кириллица же, при этом, используется только для именования самого топика - <TITLE> Tag. В тексте, при вставке ссылки на топик, в качестве Caption пишется не название главы, на которую ведет ссылка, а используется переменная <%TARGETTITLE%>. К примеру,

Топик на который будем ссылаться:
<Topic ID>: Topic3-1
<TITLE> Tag: Состав дистрибутива

Свойства ссылки на данный топик в тексте:
Caption: <%TARGETTITLE%>
Tooltip: Перейти к главе "<%TARGETTITLE%>"
Style: Link
Target: Topic3-1
Help file: (Current)
Window: (Same Window)

В результате вставки такого топик-линка, в тексте мы увидим: Состав дистрибутива
При щелчке левой кнопкой мыши - перейдем на нужную главу, а при наведении на нее - увидим подсказку "Перейти к главе "Состав дистрибутива".
 
Цитата
H&M User пишет:
Цитата
Alex_Gur пишет:
Кажется, топик-линки. Мы в основном используем их.
И внутренние ссылки (ссылки на другие топики внутри файла).
Тогда понятно, откуда у Вас в топик-линках берется кириллица. Именуете Topic ID по-русски? Представляете, если одновременно несколько писателей работают с одним проектом в H&M, то какая каша получается? Ссылки идут по Topic ID, а они не должны быть на кириллице - гораздо проще их обозвать 1, 1.3.1 или Topic1-2, чтобы облегчить сборку комплексного или сетевого проекта и даже ради сохранения сортировки в списке Target при вставке линка. Кириллица же, при этом, используется только для именования самого топика - <TITLE> Tag. В тексте, при вставке ссылки на топик, в качестве Caption пишется не название главы, на которую ведет ссылка, а используется переменная <%TARGETTITLE%>. К примеру,

Топик на который будем ссылаться:
<Topic ID>: Topic3-1
<TITLE> Tag: Состав дистрибутива

Свойства ссылки на данный топик в тексте:
Caption: <%TARGETTITLE%>
Tooltip: Перейти к главе "<%TARGETTITLE%>"
Style: Link
Target: Topic3-1
Help file: (Current)
Window: (Same Window)

В результате вставки такого топик-линка, в тексте мы увидим: Состав дистрибутива
При щелчке левой кнопкой мыши - перейдем на нужную главу, а при наведении на нее - увидим подсказку "Перейти к главе "Состав дистрибутива" .
Спасибо за ответ.
Указывать в качестве Topic ID номер раздела, как мне кажется, очень неудобно. Сегодня он - 1.3.1, а завтра, может быть, станет 2.5, а номер 1.3.1 будет иметь другой раздел.
Как вам удается решить эту проблему?
Если у вас появятся вопросы, пожалуйста, обращайтесь - будем думать вместе!
 
Цитата
Alex_Gur пишет:
Указывать в качестве Topic ID номер раздела, как мне кажется, очень неудобно. Сегодня он - 1.3.1, а завтра, может быть, станет 2.5, а номер 1.3.1 будет иметь другой раздел.
Как вам удается решить эту проблему
Почему не использовать в Topic ID имя этого же файла, если в файле один topic ID?
 
Цитата
''ADVANCED'' пишет:
Цитата
Alex_Gur пишет:
Указывать в качестве Topic ID номер раздела, как мне кажется, очень неудобно. Сегодня он - 1.3.1, а завтра, может быть, станет 2.5, а номер 1.3.1 будет иметь другой раздел.
Как вам удается решить эту проблему
Почему не использовать в Topic ID имя этого же файла, если в файле один topic ID?
Может быть я не понял вашего сообщения. В файле обычно много Topic ID, например, по числу разделов.
Если у вас появятся вопросы, пожалуйста, обращайтесь - будем думать вместе!
Страницы: 1 2 След.
Читают тему