Заказать звонок

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

Форум » Пользователи » '''ADVANCED'''

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

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

Страницы: Пред. 1 ... 10 11 12 13 14 15 16 17 18 19 20 ... 72 След.
Как техническому писателю получать консультации от разработчиков? Инструкция к применению, Учимся мягко и настойчиво выбивать всею информацию от программистов!
 
[QUOTE]writer пишет:
если, например, этот пункт Выбираем носителя информации из числа разработчиков , реализовать нельзя?
[/QUOTE]
САБЖ!

В теме [B]Как техническому писателю получать консультации от разработчиков?[/B] такой пункт есть всегда.

Если реализовать нельзя, то вопрос выносится в другую тему.

[QUOTE]techwriter пишет:
Или носитель информации уволился несколько лет назад  :)  ))
[/QUOTE]
Есть его последователи, которым первоначальный носитель передавал знания. Конечно если проект все еще поддерживается. Если программист уволился несколько лет назад, а вопрос не возникал за эти годы, возможно это не актуально. В данном случае посоветовал бы обратиться к менеджеру проекта и обсудить целесообразность. Возможно начальству покажется нерентабельным занимать кучу писателей на поиск устаревшей информации, вместо того чтобы выполнять текущие задачи.
Классификация технической документации, В этой теме рассматриваем какие виды технической документации существуют
 
Разработчик может быть пользователем только когда есть чем пользоваться. Если системный архитектор только создает структуру ПО и продумывает связи на этапе изучения ТЗ. то пользователей программы не может существовать в природе, независимо кто они. Они только на бумаге фигурируют.
Как ссылаться на .chm справку из приложения по ключевому слову?, Обсуждаем процесс интеграция help-справки и программного обеспечения (F1)
 
[QUOTE]techwriter пишет:
К сожалению, H&M у нас нет. Владею только HHW, поэтому у меня самописная chm-справка, которая состоит из HTML, CSS и JS.
[/QUOTE]DITA Open Toolkit :)
Как ссылаться на .chm справку из приложения по ключевому слову?, Обсуждаем процесс интеграция help-справки и программного обеспечения (F1)
 
[QUOTE]techwriter пишет:
Какая актуальная тема  :)  ))
К сожалению, H&M у нас нет. Владею только HHW, поэтому у меня самописная chm-справка, которая состоит из HTML, CSS и JS. Сегодня как раз будет привязывать справку к приложению и тестировать на пилоте  :)  )
Тоже сначала хотели привязывать через Topic ID. Нам показалось муторным в дальнейшем работать с ID. Решили, что путь к файлу уникален.
Пробовали сначала автоматизировать процесс получения справки в нужном месте через вызов соответствующего файла, дабы сократить ручную работу программиста. Предполагалась соответствующая структура справки. Но не получилось из-за некоторых ограничений средств разработки. В итоге, договорились, что программист просто указывает в нужном месте путь к нужному разделу справки. Пользователь, находясь в этом разделе, нажимает кнопку F1. Открывается привязанный раздел справки.
[/QUOTE]Еще вариант: договориться с программистом, чтобы он зафиксировал путь к файлу в виде переменной в коде программы. Значение этой переменной читается в config-файле. Т.е. писатель/админ и т.п. может без участия программиста менять файлы справки CHM и их расположение.

В каждой форме/окне программы прописывается ссылка на topicID. Программист выдумывает уникальный topicID как ему вздумается (лучше латиницей) на момент разработки формы/окна. Писатель указывает этот topicID в своей справке на момент создания описания. В форме программы по нажатию F1 вызывается нужная страница справки "путь из config"+"topicID". Если topicID не найден, то не вызывается.


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


Таким образом, на программиста ложится задача один раз придумать уникальный topicID при создании новой формы/окна/представления, а разработка справки и привязка ее к программе лежит на плечах писателя.
Изменено: ADVANCED - 20.08.2014 11:44:24
Классификация технической документации, В этой теме рассматриваем какие виды технической документации существуют
 
[QUOTE]techwriter пишет:
Если я не привязана к каким-либо стандартам, то я упрощаю и называю всю документацию пользовательской
[/QUOTE]Но она не вся пользовательская. Есть ТЗ, есть документация разработчиков и т.д.
Описание форматов или протоколов, которые не входят в ТЗ не может быть пользовательской документацией по определению. Само ТЗ также не может быть пользовательским :)
Как техническому писателю получать консультации от разработчиков? Инструкция к применению, Учимся мягко и настойчиво выбивать всею информацию от программистов!
 
[QUOTE]writer пишет:
Какие вопросы вы задаете разработчикам при "первом контакте" по новому функционалу?
[/QUOTE]1. Определяем цели.




2. Выбираем носителя информации из числа разработчиков

..



3. Подходим и просим:  "Мне нужна твоя одежда, ботинки и мотоцикл!"




Не забывая добавить "Пожалуйста", чтобы не ломать никому руки..
Классификация технической документации, В этой теме рассматриваем какие виды технической документации существуют
 
[QUOTE]techwriter пишет:
Приведу пример классификации пользовательской документации.
[/QUOTE]Пользовательская документация относится к типу Эксплуатационная. А эксплуатационная входит в техническую.

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

Еще есть ПМИ и документация по разработке ПО, ее пока не знаю куда отнести.
Болтовня в реальном времени, Чат технических писателей, технические писатели в прямом эфире
 
Взаимно!!!
Обсуждаем санкции против России!
 
Цитата
Марина пишет:
Вообще-то запрет на ввоз продуктов - это санкции России против стран ЕС.
Вообще-то это один из результатов санкций ЕС и США против России. Они инициировали разного рода санкции.
Обсуждаем санкции против России!
 
Ешь ананасы, рябчиков жуй,
День твой последний приходит, буржуй
Обсуждаем санкции против России!
 
Цитата
writer пишет:
а мы сыра вчера французского и вина взяли, помянули луга и виноградники Франции  :)
Скоро будете есть исконно-белорусскую семгу и традиционные казахские сыры с плесенью )))
Обсуждаем санкции против России!
 
Слон и моська :)
Как изменить фон отдельного раздела
 
[QUOTE]zukatoka пишет:
<topic class="Popup" template="Default" lasteditedby="">
[/QUOTE]Сделать новый класс и в css для него изменить фон.
Болтовня в реальном времени, Чат технических писателей, технические писатели в прямом эфире
 
Цитата
writer пишет:
А мы в соседний городок в дендрарий ездили
Это что за городок ?
Презентация разработанной документации, Как сделать презентацию разработанной документации. Обсуждаем методы представления разработанной документации Заказчику.
 
А у меня система сборки документации сама рассылает кому письма на почту о выходе новоей вверсии, кому архивы с документами по pscp.  :D
Болтовня в реальном времени, Чат технических писателей, технические писатели в прямом эфире
 
Цитата
techwriter пишет:
Привет! Я клубнику в выходные разделывала :-)
Она же 2 месяца назад закончилась )
Вопросы и ответы
 
[QUOTE]TechW пишет:
3. Сократить эту строчку, стерев . <param ref-name="title"/></variable>
[/QUOTE]Все правильно!
Ссылка на термин в документе, Как правильно оформить в тексте инструкции термин из раздела "Термины и ...
 
[QUOTE]Гость пишет:
Как правильно написать в документе термин, находящийся в оазделе термины и определения?
[/QUOTE]
Строго на русском языке, без ошибок, в соответствии с последовательностью букв в термине. Также можно склонять и использовать во множественном числе  ))))  

[QUOTE]Гость пишет:
Было написано:"При работе программист (номер подпункта из раздела терминов) использует руки..."
[/QUOTE]Бред. Вместо того, что бы заниматься разработкой продукта и документации, вы страдаете [B]х[/B][I]{censored}[/I][B]нёй[/B] и протираете штаны )
Вопросы и ответы
 
[QUOTE]TechW пишет:
1. Что нужно прописать в build файле чтобы отображались ссылки?
[/QUOTE]А они не отображаются? [QUOTE]TechW пишет:
Правильно ли я поняла, что ссылка типа "бла-бла-бла (Рис.1) " не получится из-за автоматической нумерации рисунков при сборке?
[/QUOTE]Нет, не правильно. Получится ссылка типа "бла-бла-бла (Рис.№[B]NNN[/B]) ", где [B]NNN[/B] номер, присвоенный автоматической нумерацией.[QUOTE]TechW пишет:
А Вы ссылаетесь на рисунки и как?
[/QUOTE]Я никак. И не нумерую их и не подписываю. По тексту и изображению и так понятно что к чему.
Болтовня в реальном времени, Чат технических писателей, технические писатели в прямом эфире
 
Цитата
Гость пишет:

Таким образом желателен опыт и навык программистра и/или опыт описания документирования возможностей языков программирования
какой язык?
Переработки, Задерживаетесь ли вы на работе?
 
Цитата
techwriter пишет:
Цитата
ADVANCED пишет:
Денег подзаработать в унылый скучный жаркий/холодный день или выходной.
Когда-то давно была возможность оплаты переработок и работы в выходные. Поднимал ЗП в 2 раза. На отпуск, например.
Можно найти "халтуру", если очень хочется.
Можно, но не прижилась у меня такая идея...
1. Переработка у того же работодателя стоит больше, чем халтура.
2. Переработка по своим проектам удобнее, т.к. уже вник в суть и не надо отвлекаться на мелочи или куда-то ездить, звонить консультироваться.
3. На рабочем компе смешивать работу с неработой сложно. Всякие системы контроля версий начнут глючить. Инструментарий тоже.
4. Есть СБ и специально обученные люди, которые мнговенно пресекут любую деятельность, направленную на "не родную" компанию. + закрыты и запрещены всевозможные мессенджеры, USB, прокси и т.п. Это практически во всех конторах, в которых работал.

Цитата
убожетымой пишет:
или час работы - 300 руб
У моего же работодателя час стоил бы примерно 833 руб.
Изменено: ADVANCED - 02.08.2014 00:00:07
Переработки, Задерживаетесь ли вы на работе?
 
Денег подзаработать в унылый скучный жаркий/холодный день или выходной.
Когда-то давно была возможность оплаты переработок и работы в выходные. Поднимал ЗП в 2 раза. На отпуск, например.  
Улучшено отображение списка или улучшена информативность отображения списка, или...
 
[QUOTE]writer пишет:
Такой вопрос, разработчики настроили отображение некоего списка, он стал более информативным, так вот как это по русски описать))
[/QUOTE]Модифицирован список "список". Добавлены новые функции "плюшка-3", "плюшка-4". Также были оптимизированы функции "плюшка-1", "плюшка-2", что повышает информативность и удобство работы Пользователя.


Смотря для кого это надо писать.

Есть документация [U]с маркетинговым наклоном[/U], где надо расхваливать свои плюшки и рассказывать какая крутая программа стала в новой версии[U] красочными не техническими выражениями[/U].

А может быть просто [U]описание изменений[/U] между новой и предыдущей версией [U]для технарей[/U]. Типа доработаны функции "такие-то", проведена оптимизация работы клиентской части программы. рефакторинг системы, ребилдинг БД и т.п.
Предопределенные значенния атрибутов (XML Mind)
 
[QUOTE]TechW пишет:
[QUOTE] ADVANCED пишет:
...после загрузки модуля редактирования схем.
[/QUOTE]Можно подробнее? Что это за модуль и где его взять?
[/QUOTE]Сервис - Установка рсширений





Потом отобразится список доступных для вашей версии модулей/плагинов/аддонов.


А дальше сложнее. Полной версии у меня нет, а как делать в триальной не помню.  Давно очень делал фиксированные значения, но всего для пары атрибутов. Тогда триальный редактор был нормальным, можно было перенастраивать его как угодно (но я тогда не силен был в схемах). Сейчас, насколько знаю, триальной версии нет, а полную покупать ради такой ерунды - не стоит.
Прошу оценить тестовое задание для технического писателя, Выполнил тестовое задание при приеме на работу, прошу оценить специалистов
 
[QUOTE]writer пишет:
[QUOTE] Andreyka пишет:
[QUOTE] ЭТО НЕ МОИ ОТВЕТЫ, А КАЖЕТСЯ БЫЛ СБОЙ И ПОД МОИМ ИМЕНЕМ КТО-ТО ДАЛ СВОИ ОТВЕТЫ.[/QUOTE][/QUOTE]Аа-а-а-а! Сорри это я вместо цитирования нажал Изменить и влез в вашу тему. Сорри! :oops:
[/QUOTE]Нечего под админом/модератором общаться на форуме с нормальными писателями. :!:
Админ управлять форумом должен, Модератор следить за общением и цензурой. А с писателями должны общаться такие же полноправные писатели.  8)
Страницы: Пред. 1 ... 10 11 12 13 14 15 16 17 18 19 20 ... 72 След.

Рейтинг@Mail.ru