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

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
RSS
[ Закрыто ] Вопрос о курсах
 
В соседней ветке опубликовано объявление о курсах, дата проведения которых - 22 сентября: http://techwriters.ru/forum/viewtopic.p ... highlight= .
Та ветка для размещения постов пользователей недоступна, а потому задаю вопросы в этой ветке.
1. Нельзя ли опубликовать более подробную программу занятий, а то в объявлении приведены только общие слова.
2. Если кто-нибудь уже участвовал в предыдущем занятии 28 июля, хотелось бы услышать мнение о его содержании и полезности.
Когда нет знания, есть мнение
 
Это же объявление! Поэтому и "слова общие" .
 
Я ж не критикую объявление. Программу хоцца :lol: .
Когда нет знания, есть мнение
 
Цитата
Это же объявление! Поэтому и "слова общие" .
Не надо путать  "объявление" и "рекламу".
"Завтра не будет горячей воды" - это объявление.
"Приглашаем на курсы технических писателей" - это реклама.
Реклама должна выпячивать пользу рекламируемого товара (услуги).
 
Цитата
Цитата
Это же объявление! Поэтому и "слова общие" .
Не надо путать  "объявление" и "рекламу".
"Завтра не будет горячей воды" - это объявление.
"Приглашаем на курсы технических писателей" - это реклама.
Реклама должна выпячивать пользу рекламируемого товара (услуги).
Там написано "Объявления!" :D  Поэтому и я говорю - "Объявление".
 
Цитата

Там написано "Объявления!"

Ну, вот на заборе написано "Танька- дура!"
И что из этого?
 
Цитата
И что из этого?
Уважаемый! Так можно любое слово перевернуть с ног на голову :D  и на заборе написать.
 
Цитата
Так можно любое слово перевернуть с ног на голову  
и на заборе написать.
Да, именно так! И если написано "Объявление", это не значит, что там именно объявление.
Еще Козьма Прутков предупреждал: "Не верь глазам своим"!
 
Прошу прощения.
Хочу вставить "свои пять копеек" в обсуждение.
Являюсь разработчиком этого курса.
В двух словах:
Курс обзорный.
Предполагаемая аудитория: разработчики в роли начинающих писателей.
Программу постараюсь выложить вечером или завтра утром.
Буду очень признателен за критику.
 
Вот программа, как есть на сегодняшний день. Курс новый, поэтому возможны изменения (не ухудшающие общую содержательность курса :) ).

3. Содержание лекционного курса

3.1. Необходимость технической документации и роль технического писателя. Система ГОСТов как метод установки требований к технической документации. Виды стандартов [4.1]. Стандарты на процесс создания продукции [4.2; 4.3]. Основные стадии работ и необходимые для их осуществления документы. Основные виды программных и эксплуатационных документов [4.3], и ГОСТы устанавливающие состав и содержание их разделов. Сходство стандартов на соответствующие документы для разных технологических процессов. Общая стандартизация технической документации (ГОСТ 2.ХХХ ЕСКД). Типовая структура эксплуатационной документации [4.4].
3.2. Техническая документация как продукция, процесс создания которой  стандартизирован. Основные этапы создания документации. Схема процесса. Разработка плана документирования. Основные вопросы, которые должен охватывать план. Поминутный, почасовой методы и метод нисходящего проектирования при определении сроков работ. Взаимоотношения между заказчиком и документатором.
3.3. Вопросы оптимального размещения информации. Разработка документации как синтез методики освоения продукта пользователем. Основные методы анализа информации пользователем. Особенности восприятия информации разными аудиториями. Логика построения документа в зависимости от аудитории. Проблемы написания «универсального документа». Необходимость установки требований к стилю изложения. Основные правила изложения материала [4.5]. Общие требования к лексике документов. Использование общих и специальных терминов в документах (правила строгого, детального, однозначного изложения). Лексика действий и отношений.
3.4. Особенности синтаксиса технической документации. Формализация изложения, ее возможности и аспекты. Значение формализации. Унификация языка. Стандартные и специфические клише. Порядок слов в предложении. Возможности инверсии грамматических членов предложения. Логическое членение предложения. Ритмическая организация речи и ее значение. Основные ошибки ритмического построения фраз: фонетические, фонетически-семантические и семантические повторы. Основные критерии оценки качества технической документации.

4. Учебно-методические материалы по курсу.

4.1. ГОСТ Р 1.0-92
4.2. ГОСТ 34.601-90
4.3. ГОСТ 19.102-77
4.4. ГОСТ 2.601-95
4.5. Стиль изложения документации пользователя программного средства.
 
Цитата
Цитата
Vadim писал(а):
Я ж не критикую объявление. Программу хоцца  .
  Мда... Покритиковать всегда приятнее чем сделать что-то.
Если мое последнее сообщение воспринято как критика, то это не так. Я просто высказал свое личное мнение, основанное на личном опыте проведения занятий...
Наш опыт позволяет говорит об обратном.
 
Господа!
Не надо ссориться. Вы оба идете, скажем так, "по тупиковому пути  развития цивилизации". Развитые страны уже давно отказались от таких методов обучения.
 
К сожалению не могу отслеживать обсуждение в реальном времени.
Позволю себе не согласиться про "тупиковый путь...".
Курс нацелен на совершенно определённую аудиторию, на разработчиков, причём, НЕ НАЧИНАЮЩИХ.
А для того, чтобы кроме разработки чего-то, и документацию к этому писать "на уровне", нужно этот уровень в голове обозначить, т.е. показать, что подходить к этому нужно системно. А для человека, уже имеющего в голове нечто (разработчика), для этого достаточно показать "контрольные точки" в знакомых местах и обратить внимание на  области, где его знания не дотягивают "до уровня". Если образно, то нужен "взгляд с вертолёта", чтобы сориентироваться и осмысленно потом лопатой работать.
Не знаю как там в развитых (и насколько) странах, а в нашей стране такой подход широко распространён, и слава богу. За примерами далеко ходить не надо:
Курсы для получения второго высшего образования. На общий первый курс для этого поступают только те, кому первое не помогло (впрочем, для таких, количество последующих значения не имеет).
Книг много хороших, например:
http://edurss.ru/cgi-bin/db.pl?cp=&page ... ru&list=94
 
Вот почему рубрикация начинается с раздела 3:

РАЗРАБОТКА ТЕХНИЧЕСКОЙ ДОКУМЕНТАЦИИ

Рабочая программа курса

1. Общие сведения о курсе
1.1. Программа курса предусматривает проведение лекций и не предусматривает проведения экзамена или зачёта.
1.2. Программа лекционного курса рассчитана на 4 академических часа.
1.3. Курс проводится в один день, предположительно - выходной. Возможно разделение курса на две части, по 2 часа, для проведения занятий в вечернее время в рабочие дни.
1.4. По окончании курса слушателям выдаётся сертификат о его прохождении.
2. Цели  и задачи  курса.
2.1 Основная цель курса – формирование у слушателей профессионального подхода к процессу написания технической документации.  Полученные знания позволят слушателям сформировать набор объективных критериев оценки своей деятельности в следующих областях:
• Планирование работы над документацией, определение состава комплекта, сроков написания документов.
• Определение условий взаимодействия с заказчиком документации, с разработчиком документируемого продукта.
• Осуществление контроля и самоконтроля качества работ по созданию документации.
2.2 В результате изучения данного курса слушатели должны получить основные теоретические знания и познакомиться с основными принципами создания технической документации, в частности:
• Ориентироваться в существующих национальных, отраслевых и корпоративных стандартах, использовать их в своей работе.
• Определять оптимальный состав комплекта документации и структуру документов, входящих в комплект.
• Оптимально для читателя систематизировать материал, входящий в документацию.
• Объективно оценивать содержательные  и стилистические особенности текста документации.
• Использовать стандартную терминологию и определения.
2.3  Курс ориентирован на слушателей, имеющих техническое образование, некоторый опыт создания продуктов, требующих описания в рамках документации. Так же предполагается наличие минимального опыта по написанию (редактированию) технической документации.
 
Цитата
Позволю себе не согласиться про "тупиковый путь...".

Позвольте вам  “не позволить”, ибо вы совершенно не поняли смысл фразы про “тупиковый путь”.
Два человека препираются по поводу содержательности, эффективности, полезности и т. п. предлагаемых занятий, априори полагая, что данные курсы являются единственным способом повышения квалификации (или её приобретения).  Говоря про “тупиковый путь”,  я никоим образом не подразумевал под этим программу курсов, а всего лишь предлагаемый способ
обучения.
Его тупиковость попытаюсь обосновать с двух позиций: экономической и технической.
Экономическая сторона дела:
- стоимость самих курсов – 3300;
- проезд в Москву (билет) от 1000 до 2000  в один конец;  
- питание ( читал, что в аэропорту Внуково стакан чая стоит 100 руб.);
- командировочные.

В общей сложности под 10000 руб. за 3-х часовые занятия.
Такие расходы могут позволить себе богатые фирмы (но они способны купить себе и уже готового специалиста). Бедным фирмам – не по карману.
Отсюда вывод (может, и ошибочный)  - основной контингент слушателей -  москвичи и жители ближайшего Подмосковья (в радиусе 101 км).
Это существенно ограничивает  потенциальный состав учащихся.
Теперь про “тупиковость”  с технической точки зрения.
Данная форма обучения  (в смысле  личного присутствия на курсах подобного рода)  изживает себя (если не изжила себя совсем).  
В мире  широкое распространение получает дистанционное обучение.
Наша фирма по заказу иностранцев  разрабатывала программное обеспечение для поддержки дистанционного обучения (ДО).
Коротко об этом. Программное обеспечение ДО  можно разделить на две части:  инструмент для авторов курса (подготовка  учебных материалов – текстовых, графических и т. п., создание тестовых  и контрольных заданий, их проверку,  контроль успеваемости  и др.)  и собственно обучающий курс (для обучающегося).  Для подготовки учебных курсов могут привлекаться  высококвалифицированные специалисты.   Скорость обучения индивидуальна (зависит от наличия свободного времени  у обучаемого, его первичных знаний и т. п.).  Переход к освоению другой темы  (урока)  возможен только после правильного выполнения  тестовых  (контрольных и практических ) заданий (это гарантирует качество обучения , в отличие от купленных “корочек” в переходе метро).
Конспектировать ничего не  надо - все учебные материалы доступны в электронном виде (и могут быть распечатаны).   Обучение напоминает  работу  с репетитором.
Количество обучаемых и их территориальное расположение не важно (нужен только Интернет).
На сегодня это самый прогрессивный  метод обучения.
Обучающие курсы могут быть записаны на компакт-диски  и продаваться независимо.
Да, практикуются и методы обучения  с личным участием преподавателя  и учеников (они называются мастер-классы), их проводят, как правило, в тех сферах, где текстовое описание  изучаемого предмета затруднительно (например, искусство). Но и в этом  случае  мастер едет, скажем, к 30 ученикам сам, а не наоборот.

Нужны ли рекламируемые здесь курсы?  Да, как временное мероприятие, чтобы  подработать,  “удержать на себе брюки”. Но если выбранный метод обучения является для компании стратегическим, имхо, это тупиковый путь.   Обсуждать здесь преимущества и недостатки предложенного курса считаю для себя лишним – в крайнем случае, жертвами  
неэффективного обучения будут десятки (или несколько сотен) человек.
В перспективе в выигрыше  будет  тот, кто  первым выйдет на рынок услуг с предложением дистанционного обучения. Конкуренты не дремлют.
Выводы делайте сами.

P. S. 1. Если бы компании типа Microsoft  проводили обучение  на курсах с личным участием, они никогда бы не смогли подготовить во всем мире столько сертифицированных специалистов.


P. S. 2. Я высказал свою точку зрения.  В дискуссию  по её обсуждению не вступаю.
 
Цитата
Господа! Не надо ссориться.
Боже упаси, никакой ссоры :D .
Цитата
Вот почему рубрикация начинается с раздела 3
Спасибо за информацию. Если можно, удовлетворите еще одно мое любопытство:
Цитата
"Стиль изложения документации пользователя программного средства" - это авторский или нормативный документ?
Цитата
В мире широкое распространение получает дистанционное обучение
Думаю, что это - следующий этап курсов.
Когда нет знания, есть мнение
 
Цитата
Боже упаси, никакой ссоры :D .
И это хорошо! :D
Цитата
"Стиль изложения документации пользователя программного средства" - это авторский или нормативный документ?
Авторский.

:!: Нашей компанией разработаны как дистанционные курсы (с 1 сентября), так и "классические" с участием преподавателя. Так же проводятся тренинги для технических писателей с выездом к заказчику (любой город РФ).

Подробности info@TechWriters.ru
Страницы: 1
Читают тему