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

techwriter (Все сообщения пользователя)

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

 Зарегистрируйтесь
Выбрать дату в календареВыбрать дату в календаре

Страницы: Пред. 1 ... 5 6 7 8 9 10 11 12 13 14 15 ... 17 След.
Классификация технической документации, В этой теме рассматриваем какие виды технической документации существуют
 
[QUOTE]Виктор Фигурнов пишет:
[QUOTE] techwriter пишет:
Документация разработчиков - тоже пользовательская документация. Чем разработчик не пользователь?
[/QUOTE]Как правило, разработчик - не пользователь. Разработчик тампакса может быть мужчиной, например. :)

Согласно ГОСТ Р ИСО/МЭК 12207-2010, п. 4.53, Пользователь - это лицо или группа лиц, извлекающих пользу из системы в процессе ее применения.
Разработчик может вообще никогда не использовать систему для извлечения пользы, т.е. для каких-то практических задач[/QUOTE]
А кто ж он?
В каком ГОСТ, указаны размеры полей документа?
 
[QUOTE]TechW пишет:
Напишите, пожалуйста, для отличившихся, какие же всё-таки поля по ГОСТ 2.105-95!

На рисунке 22 (где речь идет о документах для двустороннего копирования указаны размеры: 20- левое поле, 5 - правое поле, о верхнем и нижнем можно только догадываться что 20).

В приложении А - Пример выполнения текстового документа размер полей не указан, зато размеры междустрочных интервалов все даны!
[/QUOTE]Если у вас предусмотрена односторонняя печать, то вы используете поля для четной страницы. Верхние и нижние поля - по 5.
Если вы внимательно читали ГОСТ 2.105, то там есть ссылка на связанный ГОСТ 2.104. Почитайте его, и вам станет еще понятнее.
Вы просто учитывайте, что конструкторские документы предполагают рамку. Соответственно, внизу, по ГОСТ 2.105, предполагается внизу основная надпись. Требования к основной надписи документа указаны в ГОСТ 2.104.
Классификация технической документации, В этой теме рассматриваем какие виды технической документации существуют
 
[QUOTE]ADVANCED пишет:
[QUOTE] techwriter пишет:
Если я не привязана к каким-либо стандартам, то я упрощаю и называю всю документацию пользовательской
[/QUOTE]Но она не вся пользовательская. Есть ТЗ, есть документация разработчиков и т.д.
Описание форматов или протоколов, которые не входят в ТЗ не может быть пользовательской документацией по определению. Само ТЗ также не может быть пользовательским  :)
[/QUOTE]Документация разработчиков - тоже пользовательская документация. Чем разработчик не пользователь? Просто другой уровень пользователя. И разработчик тоже может быть начинающим, кстати. Для начинающих разработчиков тоже, по моему мнению, должна быть отдельная документация.
Ты конечному пользователю ТЗ даешь? Конечный пользователь = пользователь, который работает с готовым продуктом. Конечному пользователю вообще проектная документация неинтересна. У него есть продукт, с которым он работает - данность, и документация, которая помогает ему с ним работать.
ТЗ относится к проектной документации, и никак иначе. ТЗ отражает требования к системе. И не всегда может существовать в конторе, и не всегда разрабатывается техническим писателем. По уму, ТЗ должно разрабатываться бизнес-аналитиком и системным аналитиком. Если документация предоставляется заказчику в соответствии с ГОСТ, то и классификация всей документации будет по ГОСТ, о чем я выше написала. В этом случае вся документация будет в общем случае классифицироваться по стадиям создания системы, определенным в стандарте и никак по-другому.
Болтовня в реальном времени, Чат технических писателей, технические писатели в прямом эфире
 
Цитата
writer пишет:
Цитата
techwriter пишет:
О, да!  :)  В субботу баню топили. Было хорошо  :)  ))
так на даче еще и банька есть? красота!  beach-smile
Да, банька есть :)))
techwriter.ru.com
Верхний колонтитул: что сначала "код документа" или "номер страницы"
 
[QUOTE]TechW пишет:
hi-hi-hi  Придерживаешься, придерживаешся одного ГОСТа а тут БАМ, а в другом совсем другие указания - не первый раз сбивает с толку.

Ну, я прийду к своим соображениям, пока хочется узнать как поступают в этом вопросе другие технические писатели.
[/QUOTE]Так вы придерживайтесь одного и не смотрите на указания другого :)))
Я четко для себя определила, что не для коробочных решений применяю 34 ГОСТ, для коробочных - 19. Соответственно, и оформляю, в зависимости от ГОСТа, которого придерживаюсь.
Классификация технической документации, В этой теме рассматриваем какие виды технической документации существуют
 
[QUOTE]ADVANCED пишет:
[QUOTE] techwriter пишет:
Приведу пример классификации пользовательской документации.
[/QUOTE]Пользовательская документация относится к типу Эксплуатационная. А эксплуатационная входит в техническую.

Если рассматривать техническую документацию, касаемо тех.писателей, я бы выделил тра пункта.
1. Эксплуатационная (руководства всех видов и для всех аудиторий, справки, FAQ)
2. Проектная (ТЗ, технические требования, спецификации)
3. Технологическая (регламенты, методики, стандарты)

Еще есть ПМИ и документация по разработке ПО, ее пока не знаю куда отнести.
[/QUOTE]
Если я не привязана к каким-либо стандартам, то я упрощаю и называю всю документацию пользовательской. Повторюсь, дальше делю по уровням пользователей.
Если придерживаюсь стандартов, то и классификация строго по ним.
Верхний колонтитул: что сначала "код документа" или "номер страницы"
 
[QUOTE]TechW пишет:
При решении вопроса "Поля" ( [url]http://techwriters.ru/forum/forum598/topic19824/[/url] ) возник новый вопрос:


В каком порядке в верхнем колонтитуле указывать код документа и номер страницы, если, например:

ГОСТ 19. 106-78 провозглашает порядок (см. Форма 1) "номер страницы"
"обозначение документа"


ГОСТ 34.602-89 провозглашает противоположный порядок (см. п.3.2).

Как поступаете Вы?
[/QUOTE]Вы определитесь, какого ГОСТа придерживаетесь, и из этого исходите.
В каком ГОСТ, указаны размеры полей документа?
 
[QUOTE]TechW пишет:
В ГОСТ 2.105-95 не нашла ни слова о размере полей!
[/QUOTE]Так они в приложениях :)))
В каком ГОСТ, указаны размеры полей документа?
 
[QUOTE]TechW пишет:
Подскажите, пожалуйста, ГОСТ в котором указаны размеры полей в текстовых документах. Я так понимаю это должен быть ГОСТ 2..... ?
[/QUOTE]ГОСТ 2.105-95.
Классификация технической документации, В этой теме рассматриваем какие виды технической документации существуют
 
Приведу пример классификации пользовательской документации. На самом верхнем уровне считаю целесообразно классифицировать по уровню пользователя (для начинающих и экспертных).
Для начинающих пользователей должны разрабатываться следующие виды документов: глоссарий, быстрый старт, туториалы, руководство пользователя. Для опытных пользователей:  глоссарий, справочник, руководство пользователя. Далее для каждого вида документов определяется свой формат.
Если документация разрабатывается по ГОСТам, то соответственно классификация должна им соответствовать.
Корпоративный стандарт (стиль) технической документации, как составить и что должен содержать документ "Корпоративный стандарт (стиль) технической документации"
 
Я писала корпоративный стандарт целых 2 раза :))) Но все, опять же, осталось "там", поэтому поделиться ничем не могу, только описанием того, как я их разрабатывала. В теме поучаствую, т.к. возможно, мне тоже совсем скоро придется писать в связи с изменением "идеологии" разработки документации.
Рекомендую разделить стандарт на две части: на сам процесс и на правила разработки документации. В принципе, если есть регламент разработки, то первую часть составлять необязательно, т.к. она будет повторять регламент.
Во второй части я определяла следующее:
1. Правила комплектования документации.
2. Требования к структуре документов.
3. Требования к стилю изложения.
4. Требования к оформлению документации.
5. Требования к технологиям и средствам разработки документации.
6. Требования к формату документации.
7. Требования к хранению документации.
Требования должны быть очень детальными, если на выходе хочется получить единообразную документацию при условии, что разрабатывается она группой технических писателей. Я, например, прописывала все: вплоть до употребления буквы ё и использования вложенных кавычек.
Также следует иметь в виду, что стандарт порождает "дочерние" документы. У меня такими документами были: "Описание стилей", "Шаблонные описания", "Шаблоны документации", "Контрольные листы проверки документации" и пр.
Болтовня в реальном времени, Чат технических писателей, технические писатели в прямом эфире
 
О, да!   :)   В субботу баню топили. Было хорошо   :)   ))
techwriter.ru.com
Болтовня в реальном времени, Чат технических писателей, технические писатели в прямом эфире
 
Доброе утро! :)
Всем интересной работы! :)
techwriter.ru.com
Примеры веб-справки
 
[QUOTE]Виктор Фигурнов пишет:
Help & Manual это вообще довольно редкая программа, и причины её популярности в России мне не понятны.

Что-то вроде популярности в России в начале 1990 г., редактора Сhiwriter, мало известного на своей родине.

В опросе технических писателей, проведенном американским сайтом WritersUA, из 501 респондентов

- 199 использует Adobe Framemaker
- 165 использует Adobe Robohelp
- 148 использует Madcap Flare
и т.д.
...
- 19 использует Help & Manual,

причем важность Help & Manual для своей деятельности 12 человек из этих 19 оценивает как крайне несущественную (1 или 2 балла по 5-балльной шкале).
[/QUOTE]Спорное утверждение.
Недавно читала батл в американском сообществе технических писателей на тему Framemaker   :)  )) У них два лагеря было: Framemaker и DITA. Первых было меньшинство. Framemaker преподносился как устаревший софт, не отвечающий современным нуждам технических писателей.
Даже не представляю, чтобы они сказали, если бы узнали, что в России основным инструментом разработки документации является Word :)))
На самом деле, я считаю, что главным в выборе средства разработки является степень достижения целей документирования. Поэтому говорить, что лучше, а что хуже... Все относительно :)))
Предложили составить регламент разработки технической документации, пытаемся систематизировать все знания о том, как составить регламент по разработке технической документации
 
[QUOTE]writer пишет:
а это что?
[/QUOTE]Диаграмма для описания бизнес-процессов.
Предложили составить регламент разработки технической документации, пытаемся систематизировать все знания о том, как составить регламент по разработке технической документации
 
[QUOTE]writer пишет:
[QUOTE] techwriter пишет:
[QUOTE]Ох, все там осталось. Но могу написать структуру, которую он содержал ;) [/QUOTE][/QUOTE]очень жаль :cry: .... Если можно, то вышлите структуру, уже будет начало положено)
[/QUOTE]Структура была такой:
1. Общие сведения.
В разделе перечислялись общие сведения о документе - его назначение и кому он адресован, что он регламентирует и различные ограничения по его применению.
2. Описание процесса документирования.
В разделе приводилась диаграмма процесса документирования в IDEF0.
3. Роли и функции участников процесса документирования.
4. Стадии создания документации.
Описывались стадии создания документации: какие работы проводятся и кем. Кто какую ответственность несет.
Предложили составить регламент разработки технической документации, пытаемся систематизировать все знания о том, как составить регламент по разработке технической документации
 
[QUOTE]writer пишет:
[QUOTE] techwriter пишет:
Я писала такой документ несколько раз. В нем описывала сам процесс разработки документации, его участников, их роли, порядок взаимодействия и пр. Регламент подписывался руководителем и распространялся всем участникам.
[/QUOTE]А есть образец? :oops:
[/QUOTE]Ох, все там осталось. Но могу написать структуру, которую он содержал ;)
Предложили составить регламент разработки технической документации, пытаемся систематизировать все знания о том, как составить регламент по разработке технической документации
 
[QUOTE]writer пишет:
Не пойму , что это за документ такой? Может "Методика разработки технической документации" но речь шла скорее всего о самом процессе разработки.
[/QUOTE]Я писала такой документ несколько раз. В нем описывала сам процесс разработки документации, его участников, их роли, порядок взаимодействия и пр. Регламент подписывался руководителем и распространялся всем участникам.
Обсуждаем санкции против России!
 
Цитата
Марина пишет:
А очевидно всем разное  :)

Во-первых, что считать началом - санкции ЕС, начало войны на юго-востоке Украины, аннексию Крыма, Майдан в Киеве (какой из), развал СССР, холодную войну...
Про каждое из этих начал можно спорить, кто там прав и по каким критериям это определять. Но честно говоря лень.
Началом санкций ЕС надо считать те действия России, после которого они были введены.
techwriter.ru.com
Обсуждаем санкции против России!
 
Цитата
Марина пишет:
Спорить "кто первый начал" можно бесконечно.
А что значит "спорить"? Неочевидный факт разве?
techwriter.ru.com
Обсуждаем санкции против России!
 
Цитата
writer пишет:
Цитата
techwriter пишет:
норвежские компании надеются, что им удастся поставлять рыбу в Россию через компании Чили
придумали себе гем...й  :)  

Вообще непонятно, они что голодом нас хотят оставить? так мы редьку есть будем, лишь бы америкосам хуже было)
Ну, в принципе овощи о молочку мы сами производим, а остальное необязательно :)) Зато не пополним ряды стран, где люди страдают ожирением :)))) Оздоровимся, так сказать :)))
techwriter.ru.com
Обсуждаем санкции против России!
 
Цитата
Elanor пишет:
с представителями латиноамериканских стран, таких как Чили и Бразилия
Вчера меня угощали грушей из Чили  :) )
Кстати:

По данным издания Dagens Næringsliv, чилийские компании заинтересованы в том, чтобы увеличить поставки рыбы и морепродуктов на российский рынок. В то же время крупные норвежские компании надеются, что им удастся поставлять рыбу в Россию через компании Чили.

РИА Новости http://ria.ru/world/20140812/1019725581.html#ixzz3ABBcD614
techwriter.ru.com
Стиль таблицы в MS word2013, нужна помощь по созданию стиля таблицы
 
[QUOTE]sonriza пишет:
У меня тоже вечные проблемы с этими таблицами. Вот например, если в этом выложенном документе создать новую таблицу (по умолчанию она будет со стилем "Сетка таблицы"  ;)  выделить ее и выбрать стиль "Netrika_Таблица", то шапочка приобретет заливу серым, и текст заголовков будет жирным, НО выравнивание текста по центру не происходит. Почему?? Я видимо тоже чего-то недопонимаю
[/QUOTE]Да и со списками проблемы есть. Вот, с 2007 вордом я меня таких проблем со стилями не было, как в 2010, например.
Изменено: techwriter - 12.08.2014 16:12:17
Стиль таблицы в MS word2013, нужна помощь по созданию стиля таблицы
 
[QUOTE]'Максим' пишет:
[QUOTE] techwriter пишет:
[QUOTE] Alex_Gur пишет:
Максим, а где таблица-то? В архиве, который я скачал, шаблон - пустой.
Выложите, пожалуйста, пример файла с таблицей, которая "не работает".
[/QUOTE]Там есть стиль таблицы, который называется Netrika_Таблица. Он, как я понимаю, и не работает.
[/QUOTE]Совершенно верно, стиль для таблицы Netrika_Таблица.
Как применяю стиль:
- создаю таблицу (путем вставки или рисованием)
- выделяю полностью таблицу курсором
- перехожу на вкладку Конструктор
- в группе Стили таблиц выбираю Пользовательские - Netrika_Таблица
Результат на картинке. Заголовки должны по центру располагатьсяЯ  :(  
[/QUOTE]Это глюк ворда. См. сюда:
[url]http://answers.microsoft.com/ru-ru/office/forum/office_2007-word/word-2007-2010-%D0%BA%D0%B0%D0%BA/d741a279-5efd-42db-8591-c3408bf3ff72[/url]
Стиль таблицы в MS word2013, нужна помощь по созданию стиля таблицы
 
У меня тоже получилось. Максим, может, вы опишите, как применяете стиль?
Страницы: Пред. 1 ... 5 6 7 8 9 10 11 12 13 14 15 ... 17 След.

Рейтинг@Mail.ru