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

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
Ответить
RSS
Подготовка к аттестации технического писателя, Список вопросов для аттестации технического пистеля. Помогите с ответами.
 
Удалено по просьбе правообладателей.
Изменено: Claiv - 19.09.2017 17:37:50
 
Цитата
Claiv написал:
1.       Перечислить средства создания документации, используемые в БЦ ?
Microsoft Word, судя по дальнейшим вопросам. Ну, и наверное, у вас есть программа для создания/редактирования скриншотов, что-нибудь для схем? Мы же не работаем в "БЦ" =)
Цитата
2. Каким образом осуществляется процесс добавления/обновления шаблона корпоративного стиля к документу в формате *.doc?
Присоединение шаблона в списках надстроек Word (а точный порядок может различаться в Word 2003-2010).
Цитата
3. Каким образом добавляется и редактируется ссылочное оглавление в Word-документе?
Добавляется поле вида TOC (table of contents), обновляется по F9 (оно собирается по заголовкам заданного уровня).
Цитата
4. Рассказать про иерархию стилей, пояснить на примере наследование характеристик стилей. Как создать новый стиль на основе уже существующего в Word
Справка по ворду в помощь =) Последний вопрос, я думаю, нагуглить можно.
Цитата
5. По какой причине не рекомендуется использовать шаблон Normal.dot и в частности стиль «Обычный» для создания документации?
Изменения, сделанные в обычном стиле, не влияют на структуру документа. Стилями текст не только "оформляется", сколько делается "разметка".
Цитата
6. Что включает в себя понятие «пользовательская документация»? Что не входит в пользовательскую документацию?
У Кагарлицкого есть чудесное определение -  полный комплект документов в печатном или электронном виде, который обеспечивает целевое применение продукта пользователем, а также является неотъемлемой частью этого продукта.
В пользовательскую документацию не входят средства обучения, руководства и справочники общего характера, служебные инструкции, технические задания, пояснительные записки к проектам и т.д.11. По какому принципу выбирается стандарт для формирования документации?
12. Рассказать о требованиях качества, предъявляемых к документации, не оговоренных в стандартах?
13. На какой стадии разработки и каким образом определяется степень подробности изложения материала?
14. Какие рекомендации необходимо соблюдать при формировании требований к документу?
15. При написании документа необходимо уточнять границы продукта, которые будут соблюдаться при написании пользовательской документации. Какие это границы?
16. Какие требования предъявляются к содержанию пользовательских документов? Раскрыть их суть, объяснить понятие «Презумпция полноты сведений», привести примеры.
17. Перечислить типы информации, излагаемой в документации пользователя. Рассказать про каждый из типов.
18. Что такое позитивные и негативные требования?
19. В чем выражается структурированность документации? Перечислить структурные элементы от большего к меньшему. Перечислить основные характеристики правильно структурированного документа.
20. Каковы оптимальные параметры структуры? Как их достигнуть?
21. Какие методики и стили изложения сведений используются техническими писателями? Пояснить, в чем достоинства и недостатки каждой из методик.
22. Описать основные способы изложения пользовательской документации. Нарисовать схемы с примерами.
23. Обозначить основной «скелет»/типовую структуру, используемый при создании руководства пользователя. Кратко описать каждый из пунктов этой структуры.
24. Как определяется терминология предметной области? Как оформляются термины в документации (пояснить на примерах)?
25. Описать создание списков и титульной фразы. Указать оптимальные параметры списков.
26. Описать «идеальный» сплошной текст.
27. Перечислить типы ссылок в документе. Пояснить на примерах. Как ведется Лист регистрации изменений?
Цитата
7. Рассказать про взаимодействие участников проекта при создании документации (схематично). Кто может повлиять на процесс создания документации?
Ну, как минимум всегда есть Заказчик и Исполнитель, и ответственные лица, информация, полученная от которых "трансформируется" в документацию. Кажется, тут можно  и самостоятелно ответить - по своему опыту, так сказать.
Цитата
8. Перечислить цели разработки документации (взгляд снаружи)?
Документация должна помогать пользователю решать их задачи. Возможно, в каком-либо стандарте будет более четкое определение.
Цитата
9. Перечислить цели разработки документации (взгляд изнутри)?
Документация должна быть актуальной, достаточной для того, чтобы пользователь мог выполнить свою работу, точной, содержать исчерпывающие сведения.
Цитата
10. Перечислить стадии создания документации. Дать краткую характеристику по каждой стадии.
У меня такое чувство, что Ваше руководство открыло для себя сборник стандартов, и большую часть ответов стоит искать там *_*

Стадии разработки

Этапы работ

Содержание работ

1. Техническое задание

Обоснование необходимости разработки программы

Постановка задачи
Сбор исходных материалов
Выбор и обоснование критериев эффективности и качества разрабатываемой программы
Обоснование необходимости проведения научно-исследовательских работ

Научно-исследовательские работы

Определение структуры входных и выходных данных
Предварительный выбор методов решения задач
Обоснование целесообразности применения ранее разработанных программ
Определение требований к техническим средствам
Обоснование принципиальной возможности решения поставленной задачи

Разработка и утверждение технического задания

Определение требований к программе
Разработка технико-экономического обоснования разработки программы
Определение стадий, этапов и сроков разработки программы и документации на нее
Выбор языков программирования
Определение необходимости проведения научно-исследовательских работ на последующих стадиях
Согласование и утверждение технического задания

2. Эскизный проект

Разработка эскизного проекта

Предварительная разработка структуры входных и выходных данных
Уточнение методов решения задачи
Разработка общего описания алгоритма решения задачи
Разработка технико-экономического обоснования

Утверждение эскизного проекта

Разработка пояснительной записки
Согласование и утверждение эскизного проекта

3. Технический проект

Разработка технического проекта

Уточнение структуры входных и выходных данных
Разработка алгоритма решения задачи
Определение формы представления входных и выходных данных
Определение семантики и синтаксиса языка
Разработка структуры программы
Окончательное определение конфигурации технических средств

Утверждение технического проекта

Разработка плана мероприятий по разработке и внедрению программ
Разработка пояснительной записки
Согласование и утверждение технического проекта

4. Рабочий проект

Разработка программы

Программирование и отладка программы

Разработка программной документации

Разработка программных документов в соответствии с требованиями ГОСТ 19.101-77

Испытания программы

Разработка, согласование и утверждение программы и методики испытаний
Проведение предварительных государственных, межведомственных, приемо-сдаточных и других видов испытаний
Корректировка программы и программной документации по результатам испытаний

5. Внедрение

Подготовка и передача программы

Подготовка и передача программы и программной документации для сопровождения и (или) изготовления
Оформление и утверждение акта о передаче программы на сопровождение и (или) изготовление
Передача программы в фонд алгоритмов и программ

Я знаю, что в ЕСКД зафиксированы стадии разработки программного продукта (с Постановкой задачи, сбором исходных материалов - у тех.писов, собственно тоже присутствуют эти стадии)..
а может тут хотят увидеть ЕСТД https://techwriters.ru/services/gost/standarty-estd-gost-3/gost-3-1102-81-estd-stadii-razrabotki-i-v...

To be continued. Свою работу пора работать.
Изменено: Elanor - 19.09.2017 17:39:35
 
Спасибо Вам огромное за помощь! С нетерпением жду продолжения! ))))
 
Цитата
Claiv написал:
Спасибо Вам огромное за помощь! С нетерпением жду продолжения!
Хотелось бы узнать (если не является комм. закрытой информацией):
1. Это аттестация в коммерческой компании?
2. Что предполагается после аттестации? Повышение/снижение ЗП (коэф.)?
3. КАК данная аттестация влияет на выпуск продукта? Что, от ее прохождения резко возрастает количество выпуженных документо-страниц?
4. Большинство из перечисленных пунктов предполагают множественные ответы, т.к. нет ссылки на нормативный документ-эталон Т.е., например, один и тот же пункт будет верным и в том, и в другом случае (или неверным), в зависимости от того, какие нормативные документы/стандарты и материалы используются в качестве оценки каждого пункта. Для справки: вариант, предполагающий единственный ответ: "23.   Обозначить основной «скелет»/типовую структуру, используемый при создании руководства пользователя, согласно ГОСТ ...."

Вывод: данная аттестация нужна, чтобы (выбирайте любой):
- Завалить/уволить неугодных людей (как несоответствующих требованиям квалификации).
- Нужна отделу персонала "для галочки" - у нас проводится периодическая аттестация персонала.
Она совершенно НЕ требуется для результата - сдачи работ заказчику, реального повышения квалификации персонала и т.п. (и, как итог - повышения косвенной прибыли компании).

Скажу вам лишь одно, такие вещи НЕ проводятся в компаниях, которые ценят своих сотрудников (и если их действительно, есть за что ценить - они приносят т.н. косвенную прибыль). Совет: начинайте медленно искать другое место работы, где у вас будут требовать:
- результат (корректный).
- в срок.
- и удовлетворяющий закзчиков.

а не формальное прохождение/ не прохождение аттестации.

P.S. Почему то на память срахзу же пришло ЕГЭ :)
Изменено: Текрайтер из Питера - 29.02.2016 15:58:10
 
Уважаемый Текрайтер!
Аттестация проводится в частной компании "Барс Груп". Ее проводят не ради "отсеивания неугодных" или "галочки", а для присвоения очередного грейда и обоснованного повышения заработной платы. Ее можно и не проходить, мой коллега, например, уже семь лет не аттестовался, ему это просто не нужно. А мне, как будущему отцу, повышение ЗП просто необходимо. Если Вы не горите желанием помогать, то хотя бы  не выливайте свой негатив в этой теме.
Счастья Вам, всех благ и творческих успехов!
 
Цитата
Claiv написал:
7. Рассказать про взаимодействие участников проекта при создании документации (схематично). Кто может повлиять на процесс создания документации?
10.   Перечислить стадии создания документации. Дать краткую характеристику по каждой стадии.
 
Цитата
Текрайтер из Питера написал:
Цитата
вариант, предполагающий единственный ответ: "23.   Обозначить основной «скелет»/типовую структуру, используемый при создании руководства пользователя,  согласно ГОСТ .... "
Думаю, что вот эта статейка Роберта Хорна Structured Writing as a Paradigm намного полезнее для понимания, как структурировать руководства пользователя, чем все написанные совковыми бюрократами ГОСТы 40-50 летней давности.
Изменено: Виктор Фигурнов - 19.09.2017 18:00:36
 
Цитата
Claiv написал:
Уважаемый Текрайтер!
Аттестация проводится в частной компании "Барс Груп". Ее проводят не ради "отсеивания неугодных" или "галочки", а для присвоения очередного грейда и обоснованного повышения заработной платы. Ее можно и не проходить, мой коллега, например, уже семь лет не аттестовался, ему это просто не нужно. А мне, как будущему отцу, повышение ЗП просто необходимо. Если Вы не горите желанием помогать, то хотя бы  не выливайте свой негатив в этой теме.
Счастья Вам, всех благ и творческих успехов!
Уважаемый Claiv!

Не ставил задачу как-то вас обидеть, а всего лишь предостеречь. Тем более, очень странно видеть "отношение обиженного". Хочу вам сказать, что ваш коллега совершенно прав. И, кстати, наверное, с количеством _практических знаний_ в голове у него все в порядке, вне зависимости от аттестации.

Я вам могу сказать только одно. Впрочем, может вы об этом знаете. Квалификация кандидата на рынке труда НЕ определяется прохождением или непрохождением данного теста, включающего вопросы вида "3.       Каким образом добавляется и редактируется ссылочное оглавление в Word-документе?". Она определяется как количеством и типами сданных проектов и вашей роли в них, так и владение вами различных технологий - как контента, так и представления  (ну, допустим, вы решите перейти в компанию, которая документирует API с использованием Sphinx и Restructured).
 
Цитата
Виктор Фигурнов написал:
Цитата
Текрайтер из Питера   написал:
Цитата
вариант, предполагающий единственный ответ: "23.   Обозначить основной «скелет»/типовую структуру, используемый при создании руководства пользователя,  согласно ГОСТ .... "
Думаю, что вот эта статейка Роберта Хорна  Structured Writing as a Paradigm  намного полезнее для понимания, как структурировать руководства пользователя, чем все написанные совковыми бюрократами ГОСТы 40-50 летней давности.
Виктор, я писал немного не о том.

Вы говорите: "_где_ взять пример/ответ на вопрос".
Я же говорил о том, что: "независимо от ответа, _в текущей формулировке_ вопроса он может оказаться с одинаковой долей вероятности как правильным, так и неправильным - не установлено _условие_ правильности". И привел пример (именно пример!) формулировки вопроса, при которой правильный ответ можно найти с большей вероятность.
Изменено: Текрайтер из Питера - 01.03.2016 16:00:37
 
Цитата
Elanor написал:
8. Перечислить цели разработки документации (взгляд снаружи)?
Цель разработки документации - повышение косвенной прибыли, либо снижение косвенных издержек (смотря с какой стороны посмотреть). И только это. Все остальное - только задачи для достижения цели.

P.S. Кстати, и вы,  Claiv, работаете не для того, чтобы разработывать документацию - это вы так думаете. Вы работаете, в первую очередь, чтобы приносить косвенную прибыль акционерам/владельцам компании. И только так.
 
Цитата
Текрайтер из Питера написал:
Я же говорил о том, что: "независимо от ответа, _в текущей формулировке_ вопроса он может оказаться с одинаковой долей вероятности как правильным, так и неправильным - не установлено _условие_ правильности". И привел пример (именно пример!) формулировки вопроса, при которой правильный ответ можно найти с большей вероятностью.
:D  :D  :D  

"Правильный по ГОСТу ответ" - по РД 50-34.698-90 руководство пользователя должно состоять из следующих разделов  wall-smile
1) введение;
2) назначение и условия применения;
3) подготовка к работе;
4) описание операций;
5) аварийные ситуации;
6) рекомендации по освоению.
Техпис, следующий этому "правильному по ГОСТу ответу", заслуживает немедленного увольнения.  :(
 
Цитата
Виктор Фигурнов написал:
Цитата
Текрайтер из Питера   написал:
Я же говорил о том, что: "независимо от ответа, _в текущей формулировке_ вопроса он может оказаться с одинаковой долей вероятности как правильным, так и неправильным - не установлено _условие_ правильности". И привел пример (именно пример!) формулировки вопроса, при которой правильный ответ можно найти с большей вероятностью.
       

"Правильный по ГОСТу ответ" - по РД 50-34.698-90 руководство пользователя должно состоять из следующих разделов  
1) введение;
2) назначение и условия применения;
3) подготовка к работе;
4) описание операций;
5) аварийные ситуации;
6) рекомендации по освоению.
Техпис, следующий этому "правильному по ГОСТу ответу", заслуживает немедленного увольнения.  
Зря вы так, Виктор :) Я лично знаю компании, которые следуют этому принципу - "ни шага назад". Документация нужна там, чтобы "сдать заказчику" и чтобы "люди из серьезных компаний сразу поняли, что имеют дело с настоящими документами" - это цитата.

Более того, они ищут таких людей - тех которые будут следовать этому принципу.

Понятно, что ни о какой коммуникации внутри компании (на уровне техдокументации) речи не идет.
Изменено: Текрайтер из Питера - 02.03.2016 16:40:23
 
Спасибо всем огромное за помощь.
Изменено: Claiv - 14.11.2016 09:16:21
 
А вы можете поделится вопросами для тестирования?
пойдем со мной?
 
спасибо большое за предоставленную здесь информацию, очень помогли!
Страницы: 1
Ответить
Читают тему
Форма ответов
 
Текст сообщения*
Загрузить файл или картинкуПеретащить с помощью Drag'n'drop
Перетащите файлы
Ничего не найдено
Загрузить файлы
Отправить Отменить