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

В телеграме канал в режиме Broadcast или что-то такое - писать может только создатель канала.

Они таки "опубликовали материалы Пятого Гипербатона, который прошел в московском офисе Яндекса 3 июня. Посмотреть и скачать видео докладов и слайды вы можете на странице мероприятия": https://events.yandex.ru/events/hyperbaton/03-june-2017/.

Я тоже думаю, что "действий".

Подписалась на канал Гипербатона в телеграме (https://t.me/hyperbaton)
Но, похоже, там где я буду 3 июня, с интернетом таки будет не очень (судя по отзывам о моем отеле))
Буду ждать записей.

Инфа из блога Яндекса
Попадает ровно на мой отпуск, поэтому я точно пропускаю.

Программы еще нет, но 29 мая уже закрывают регистрацию.
Буду ждать видео с мероприятия =)

У меня перестали вставляться ссылки в этом редакторе





диалог с родителем и ребенком





- Стилистика в технической документации

Возвращение к пользователю


Инструменты разработки документации



Модель оценки эффективности контента

revo, огромное спасибо за ссылки!
Правильная ссылка на видео  (промотана пустая заставка без действия)

Сленг, конечно.
"Возможность" или "функция" - зависит от контекста, ИМХО.

Подборки новых ИТ- слов с хабра
https://habrahabr.ru/company/parallels/blog/231607/
https://habrahabr.ru/company/mailru/blog/191998/

[URL=http://techwriters.ru/forum/topic/new/]http://techwriters.ru/forum/topic/new/[/URL]
Я только так захожу (Если что - Кнопочка Обновления) рядом со ссылкой на профиль  и подписки и вот это всё.
Не оно?

Пользуемся только для документации, переведенной на английский язык.
Ибо даже синтаксические правила очень сильно различаются (первое, что вспоминается - разный подход к оформлению списков).

Опубликовали видео https://yandex.ru/blog/x-plain/itogi-chetvertogo-giperbatona

https://events.yandex.ru/events/hyperbaton/04-june-2016/#desc
Гипербатон пройдёт одновременно в Москве, Санкт-Петербурге и Екатеринбурге.Во всех городах встречать гостей будут технические писатели Яндекса. Мы организуем телемост, который свяжет всех участников. Можно будет слушать доклады коллег из других городов и задавать им вопросы. На конференции выступят специалисты Яндекса и других компаний.
Основные темы:
- поиск и обучение писателей для разработческой документации;
- генерация документации из кода;
- единый источник;
- использование баз данных для унификации текстов;
- локализация документации.

Программу обещают позже.
Если пойдете, нужно пройти регистрацию https://events.yandex.ru/events/hyperbaton/04-june-2016/register/ до 17:00 31 мая по Москве.

3 марта - Всемирный день писателя! +)
Можно примазаться  )) Хотя, помнится, мы тут свой день техписа высчитывали.

Поздравляю всех!))

[QUOTE]Claiv написал:
1.       Перечислить средства создания документации, используемые в БЦ ?

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

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

[/TD][TD]

Этапы работ

[/TD][TD]

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

[/TD][/TR][TR][TD]

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

[/TD][TD]

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

[/TD][TD]

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

[/TD][/TR][TR][TD]

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

[/TD][TD]

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

[/TD][/TR][TR][TD]

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

[/TD][TD]

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

[/TD][/TR][TR][TD]

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

[/TD][TD]

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

[/TD][TD]

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

[/TD][/TR][TR][TD]

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

[/TD][TD]

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

[/TD][/TR][TR][TD]

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

[/TD][TD]

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

[/TD][TD]

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

[/TD][/TR][TR][TD]

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

[/TD][TD]

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

[/TD][/TR][TR][TD]

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

[/TD][TD]

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

[/TD][TD]

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

[/TD][/TR][TR][TD]

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

[/TD][TD]

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

[/TD][/TR][TR][TD]

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

[/TD][TD]

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

[/TD][/TR][TR][TD]

5. Внедрение

[/TD][TD]

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

[/TD][TD]

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

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

To be continued. Свою работу пора работать.

Расскажите, как там на конференции?
А то мы тут всё работу работаем, не знаем, что в мире происходит.

Ну еще бы она не тормозила!
Пока всю инфу в Майкрософт отправит, пока скриншот с включенной камеры сделает..
http://habrahabr.ru/post/267507/#first_unread

Не рискую пока обновляться на это.
а вот мама моя свой ноутбук обновила. но вроде бы разобралась, как в новой винде "фоточки заливать".

Пока была на больничном, не заходила на форум - ну как-то было не до того.
Захожу сегодня и вижу, что кроме "лайков", у нас есть теперь "рейтинг" и "авторитет".
Чем один отличается от другого?
и традиционно:
"Локи, ну нафига?"

Денис, благодарю за ответ. Нужный раздел в инструкции нашла без проблем.

Виктор, огромное спасибо за ответ и ссылки

Коллеги, у меня появился вопрос для тех, кто пользуется программами для разработки документации, в частности - встроенной справки.
А каким образом в таком редакторе страница справки может быть привязана к форме в программе?
Нужно, чтобы написанная страница открывалась по нажатии F1 или кнопки "Справка".

Предоставляют ли существующие программы такую возможность?
Как это обычно реализуется?

"Согласно нормам правописания XIX века, слово «пескарь» в этой сказке традиционно пишется через «и» — «пискарь», в том числе в современных академических (с комментариями) изданиях Салтыкова-Щедрина. "

Так что - это традиционная книжка.

Есть автоматизированные средства, например Doxygen
Objective-C поддерживает.
На сколько, я понимаю, она использует комментарии в коде.

Я с этой программой, правда, не работала. Не было подобных задач.

Или вот JSDuck - [URL=http://habrahabr.ru/post/214591/]http://habrahabr.ru/post/214591/[/URL]
все это - генераторы документации.
Надеюсь, мой ответ хоть как-то поможет.

У нас документация публикуется на веб-сайте.
На нем реализовали возможность "отправить отзыв".
Пользователи могут написать отзыв в виде письма, в теле которого будет указан адрес страницы, о которой пользователь пишет.