Оставить заявку

Переквалификация в техписы. Нужна помощь

Внимание! У нас сбои с почтовым сервером! Если не пришло письмо о регистрации или смене пароля напишите нам на info@techwriters.ru! 
@twriters
 obmen_soobsheniyami.pngчат для технических писателей в Telegram

 Зарегистрируйтесь
   RSS
Переквалификация в техписы. Нужна помощь
 
Всем жителям форума привет. Начну свой рассказ с того, что на данный момент я работаю в фирме, которая занимается вентиляцией. Работаю руками, кручу отверткой, собираю, настраиваю и тд. Учусь в институте на ИТишника.Почти 4й курс.  В фирме открылась вакансия техписа. Есть небольшой(мизерный) шанс занять ее. Основная, как я понимаю работа - это паспорта к модулям управления вентиляцией. У нас конечно же есть они, но не по гостам.
Хотелось бы помощи и напутствий получить) К начальству надо идти с чем-то, т.е. с примером твоего труда, дабы хоть как-то заинтересовать.
Поэтому подскажите. Как же сделать этот паспорт правильно? какие госты нужны и как все оформлять,используя их, какие нормы по оформлению и тд. ?
Страницы: Пред. 1 2
Ответы
 
Цитата
Alex_Gur пишет:
Указывать в качестве Topic ID номер раздела, как мне кажется, очень неудобно. Сегодня он - 1.3.1, а завтра, может быть, станет 2.5, а номер 1.3.1 будет иметь другой раздел.
Как вам удается решить эту проблему?
Не разу не становился. 34 и 19 ГОСТ довольно неплохо задают структуру документа (вплоть до 3го уровня). К примеру, в одном из наших шаблонов обычно:

Код
1 Введение
  1.1 Область применения
  1.2 Краткое описание возможностей
  1.3 Уровень подготовки пользователей
  1.4 Перечень эксплуатационной документации
2 Назначение и условия применения
  2.1 Виды деятельности, функции
    2.1.1 Цели системы
    2.1.2 Функции системы
    .... сюда добавляем свое
  2.2 Программные и аппаратные требования
    2.2.1 Требования к оборудованию
    2.2.2 Требования к программному обеспечению
    .... сюда добавляем свое
3 Подготовка к работе
  3.1 Состав дистрибутива
  3.2 Установка системы
    3.2.1 Установка с использованием установщика
    3.2.2 Ручная установка
  3.3 Запуск системы
  3.4 Проверка работоспособности
4 Описание интерфейса
  ... здесь вставляем свои топики или подключаем внешний проект, описывающий интерфейс
5 Описание операций
  ... здесь вставляем свои топики или подключаем внешний проект, описывающий операции
6 Аварийные ситуации. Восстановление базы данных
7 Рекомендации по освоению
Согласно этого, никогда ни одна глава не будет менять свой ID (будут лишь появляться новые; стандартный шаблон подключается как репозиторий или просто файлом шаблона проекта). Даже при подключении внешнего сетевого проекта для сборки, H&M автоматически меняет ID топика. Как он называется, Topic3-1-2(2) (H&M автоматически добавляет цифру в скобках при двойном ID) или 3-2-2-2-1 - абсолютно неважно, меня это не интересует, при вставке линка я указываю его лишь раз - ID топика показывается во всплывающей подсказке при наведении на данный топик. Ссылки все равно прекрасно работают. Да, если неудобно - можно и подправить Topic ID, скорее всего, все равно придется задавать в Topic Options значение переменных счетчиков рисунков и таблиц, чтобы по всему сборному проекту было правильно (если это подключаемый проект другого пользователя, а он не удосужился это сделать, хотя можно и заставить подправить его самого - все наши проекты сетевые и в формате Uncompressed XML (а-ля DITA), поэтому можно работать толпой над одним проектами любой сложности.

P.S.: Кто не знаком с форматами проектов H&M, поясню:
  • *.hmxZ - стандартный ZIP-архив, содержащий xml-проект H&M;
  • *.hmxP - xml-проект H&M - подходит для многопользовательского редактирования;
  • *.hmskin - дизайн-проект, содержащий html-тимплейты, переменные, baggage-файлы и прочее как шаблон проекта;
  • *.hmxr - проект-содержание, содержащий топики, html-тимплейты, переменные, baggage-файлы и прочее как репозиторий;
  • *.hmx, *.hm3 - проекты H&M старых версий.
Изменено: 'H&M User' - 22.05.2013 12:29:04
 
Цитата
''ADVANCED'' пишет:
Почему не использовать в Topic ID имя этого же файла, если в файле один topic ID?
В H&M проектах обычно такого не случается. Зачем делать файл, содержащий один топик? В H&M файл - это всегда проект, содержащий кучу топиков и, соответственно Topic ID.
 
Цитата
'H&M User' пишет:
Цитата
Alex_Gur пишет:
Указывать в качестве Topic ID номер раздела, как мне кажется, очень неудобно. Сегодня он - 1.3.1, а завтра, может быть, станет 2.5, а номер 1.3.1 будет иметь другой раздел.
Как вам удается решить эту проблему?
Не разу не становился. 34 и 19 ГОСТ довольно неплохо задают структуру документа (вплоть до 3го уровня). К примеру, в одном из наших шаблонов обычно:
Код
 1 Введение
  1.1 Область применения
  1.2 Краткое описание возможностей
  1.3 Уровень подготовки пользователей
  1.4 Перечень эксплуатационной документации
2 Назначение и условия применения
  2.1 Виды деятельности, функции
    2.1.1 Цели системы
    2.1.2 Функции системы
    .... сюда добавляем свое
  2.2 Программные и аппаратные требования
    2.2.1 Требования к оборудованию
    2.2.2 Требования к программному обеспечению
    .... сюда добавляем свое
3 Подготовка к работе
  3.1 Состав дистрибутива
  3.2 Установка системы
    3.2.1 Установка с использованием установщика
    3.2.2 Ручная установка
  3.3 Запуск системы
  3.4 Проверка работоспособности
4 Описание интерфейса
  ... здесь вставляем свои топики или подключаем внешний проект, описывающий интерфейс
5 Описание операций
  ... здесь вставляем свои топики или подключаем внешний проект, описывающий операции
6 Аварийные ситуации. Восстановление базы данных
7 Рекомендации по освоению
 
Согласно этого, никогда ни одна глава не будет менять свой ID (будут лишь появляться новые; стандартный шаблон подключается как репозиторий или просто файлом шаблона проекта). Даже при подключении внешнего сетевого проекта для сборки, H&M автоматически меняет ID топика. Как он называется, Topic3-1-2(2) (H&M автоматически добавляет цифру в скобках при двойном ID) или 3-2-2-2-1 - абсолютно неважно, меня это не интересует, при вставке линка я указываю его лишь раз - ID топика показывается во всплывающей подсказке при наведении на данный топик. Ссылки все равно прекрасно работают. Да, если неудобно - можно и подправить Topic ID, скорее всего, все равно придется задавать в Topic Options значение переменных счетчиков рисунков и таблиц, чтобы по всему сборному проекту было правильно (если это подключаемый проект другого пользователя, а он не удосужился это сделать, хотя можно и заставить подправить его самого - все наши проекты сетевые и в формате Uncompressed XML (а-ля DITA), поэтому можно работать толпой над одним проектами любой сложности.

Все же, допустим, номер раздела изменился. Например, он был
Код
2.2 Программные и аппаратные требования
а стал
Код
3.2 Программные и аппаратные требования
ID топика по-прежнему остается 2.2.
Допустим, мне нужно дать ссылку из другого раздела на указанный выше раздел.
В версии 5 в поле Target у нас сейчас выводятся ID топиков на русском языке. Найти нужный раздел легко, и обычно он даже "подставляется" сам.
Если этот ID будет 2.2, то придется помнить, что раньше он имел в тексте номер 2.2, а теперь изменился. Если не помнить, что когда-то он был 2.2, то данного раздела в поле Target не найдешь.
Или я ошибаюсь?
Изменено: Alex_Gur - 22.05.2013 12:48:51
Если у вас появятся вопросы, пожалуйста, обращайтесь - будем думать вместе!
 
Цитата
Alex_Gur пишет:
Если не помнить, что когда-то он был 2.2, то данного раздела в поле Target не найдешь.
Обычно перед вставкой ссылки на какой-то раздел - я навожу на него мышью в Project Explorer и во всплывающей подсказке смотрю значение Links To: КУДА и только после этого вставляю топик-линк. В окне вставки линка, чтобы не искать в списке топиков - в поле Target просто пишу КУДА (достаточно ввести пару первых символов). Пусть на то, чтобы посмотреть значение Links To у Вас может уйти секунда-две, но теперь зато Вы точно знаете, что в итоге получите правильную ссылку на нужный раздел, да и листать не надо.

P.S.: Вышеописанное не относится к разным разделам с одинаковым Topic ID (разделы, копируемые с помощью Drag&Drop при удержании Ctrl+Shft).
Изменено: 'H&M User' - 22.05.2013 13:55:32
 
Цитата
'H&M User' пишет:
Цитата
Alex_Gur пишет:
Если не помнить, что когда-то он был 2.2, то данного раздела в поле Target не найдешь.
Обычно перед вставкой ссылки на какой-то раздел - я навожу на него мышью в Project Explorer и во всплывающей подсказке смотрю значение Links To: КУДА и только после этого вставляю топик-линк. В окне вставки линка, чтобы не искать в списке топиков - в поле Target просто пишу КУДА (достаточно ввести пару первых символов). Пусть на то, чтобы посмотреть значение Links To у Вас может уйти секунда-две, но теперь зато Вы точно знаете, что в итоге получите правильную ссылку на нужный раздел, да и листать не надо.

P.S.: Вышеописанное не относится к разным разделам с одинаковым Topic ID (разделы, копируемые с помощью Drag&Drop при удержании Ctrl+Shft).
В общем, когда программа поддерживала кириллицу, было лучше. Но и к 6-й версии можно приспособиться.
Большое спасибо.
Если у вас появятся вопросы, пожалуйста, обращайтесь - будем думать вместе!
 
Цитата
Alex_Gur пишет:
Большое спасибо
Всегда рад помочь! И да, многие остались на 5 версии именно из-за этого. Хотя, я мечтаю, чтобы скорее 6.3 из беты превратилась в релизную (очень хорошо они там поправили импорт/экспорт).
 
Цитата
Гость пишет:
Доброго времени суток, Уважаемые!
Гуляя по форуму наткнулся на эту тему. Не могло не вызвать улыбку описание вставки формул в графическом виде или подстановки xml-кода.  :)  Работаю тех. писателем пару лет, однако, таких проблем не возникало никогда. Про DITA слышал, тем не менее, ни разу на нее не заглядывался. Использую только H&M (в настоящее время 6.2.3). Создал репозитории со структурой для любых! возможных документов, нарисовал pdf-шаблоны под 34 и 19 ГОСТ, сделал текстовые сниппеты для листов утверждения, файлы для импорта необходимых переменных ФИО и автоматических счетчиков рисунков и таблиц, сделал парочку шаблонов для сайтов с анимацией и импорт-проекты для всплывающих окон на js и т.д.
Работать просто и легко, исполняются любые прихоти заказчиков (это ни в коем случае не реклама, а совет новичкам). А для вставки формул используется OLE-объект MS Equation 3.0

Гость,

Цитата
Гость пишет:
Доброго времени суток, Уважаемые!
Гуляя по форуму наткнулся на эту тему. Не могло не вызвать улыбку описание вставки формул в графическом виде или подстановки xml-кода.  :)  Работаю тех. писателем пару лет, однако, таких проблем не возникало никогда. Про DITA слышал, тем не менее, ни разу на нее не заглядывался. Использую только H&M (в настоящее время 6.2.3). Создал репозитории со структурой для любых! возможных документов, нарисовал pdf-шаблоны под 34 и 19 ГОСТ, сделал текстовые сниппеты для листов утверждения, файлы для импорта необходимых переменных ФИО и автоматических счетчиков рисунков и таблиц, сделал парочку шаблонов для сайтов с анимацией и импорт-проекты для всплывающих окон на js и т.д.
Работать просто и легко, исполняются любые прихоти заказчиков (это ни в коем случае не реклама, а совет новичкам). А для вставки формул используется OLE-объект MS Equation 3.0  :)
А вы не поясните что такое DITA?и если не сложно,можете поделиться шаблонами для 19 госта?((я новичок в оформлении технической документации,прохожу практику,а нормальные шаблоны не могу найти,увы
 
Цитата
А вы не поясните что такое DITA?и если не сложно,можете поделиться шаблонами для 19 госта?((я новичок в оформлении технической документации,прохожу практику,а нормальные шаблоны не могу найти,увы
если вы новичок, то к дита пока и близко не подходите
 
Цитата
Гость пишет:
Цитата
А вы не поясните что такое DITA?и если не сложно,можете поделиться шаблонами для 19 госта?((я новичок в оформлении технической документации,прохожу практику,а нормальные шаблоны не могу найти,увы
если вы новичок, то к дита пока и близко не подходите
а вы не подскажете,в каком тогда специализированном програмном обеспечении можно составлять и работать с технической документацией по 19 госту?и чтоб с шаблонами???
 
Цитата
а вы не подскажете,в каком тогда специализированном програмном обеспечении можно составлять и работать с технической документацией по 19 госту?и чтоб с шаблонами???
Работать можно в любом, даже в Word, шаблон по ГОСТу я же вам написал где взять, берете этот шаблон и пишите в нем что хотите, в чем сложности то?
Можно по ГОСТ работать в Help&Manual, в AutorIT и др  но везде нужно настраивать шаблон для вывода по ГОСТ. Поэтому в вашем случае лучше всего взять готовый шаблон ГОСТ 19 серии поменять название ПО и продолжить в этом шаблоне писать свой новый документ и все. Это самый простой вариант, проще уже нет.
 
Здравствуйте! Собираюсь переквалифицироваться из юриста в технического писателя. Отсюда возник вопрос: есть ли среди технических писателей бывшие юристы? Как я понял, техническое образование не является обязательным, а навыки канцелярского слога не скажутся пагубно на будущей карьере. На работе приходится довольно часто разрабатывать договоры и так называемые "политики конфиденциальности" для IT-специалистов. Также был опыт внедрения стандартов ISO на крупном предприятии. Считаете, у меня есть возможность стать достойным техническим писателем?  
 
Цитата
Lawyer написал:
Здравствуйте! Собираюсь переквалифицироваться из юриста в технического писателя. Отсюда возник вопрос: есть ли среди технических писателей бывшие юристы? Как я понял, техническое образование не является обязательным, а навыки канцелярского слога не скажутся пагубно на будущей карьере. На работе приходится довольно часто разрабатывать договоры и так называемые "политики конфиденциальности" для IT-специалистов. Также был опыт внедрения стандартов ISO на крупном предприятии. Считаете, у меня есть возможность стать достойным техническим писателем?
Добрый день,
Думаю, все будет нормально.
Нужно будет грамотно писать и знать основы той области, которую Вы будете описывать. Также нужно будет быть готовым учиться новым IT-технологиям.
Хорошее владение литературным языком - это плюс, но чаще от Вас будут требоваться формализированные описания.
Программу нужно описать так, чтобы даже малосведующему пользователю было понятно, как с ней работать.
Также нужно хорошо знать особенности программы, в которой Вы описываете (например, MS Word).
Изменено: Alex_Gur - 30.03.2016 11:23:03
Если у вас появятся вопросы, пожалуйста, обращайтесь - будем думать вместе!
 
Значит, все-таки бывших юристов нет.
 
Цитата
Lawyer написал:
Значит, все-таки бывших юристов нет.
Откуда такой вывод? :)
Если у вас появятся вопросы, пожалуйста, обращайтесь - будем думать вместе!
 
Обратного никто не написал.
 
Цитата
Lawyer написал:
Обратного никто не написал.
Просто мало кто форум посещает :)
 
Цитата
Lawyer написал:
Здравствуйте! Собираюсь переквалифицироваться из юриста в технического писателя. Отсюда возник вопрос: есть ли среди технических писателей бывшие юристы?
Есть такие и думаю их будет с каждым годом больше.
Страницы: Пред. 1 2
Читают тему

Рейтинг@Mail.ru