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

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

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

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

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

Проблема в том, что вы должны не только рассказать, как выполнять действие, но и что это за действие. Часто также надо указать, когда и почему оно выполняется. Иногда также необходимо указать, в соответствии с какими требованиями оно должно выполняться, какие имеются типичные ошибки при его выполнении, и т.д. Иногда надо объяснить, почему выбран именно такой способ выполнения этого действия, а не иной... В терминологии DITA - нужно описывать не только task, но до нее изложить concept, а после нее дать reference. Не зная предметной области автоматизированной системы, задач и потребностей её пользователей, вы сможете сделать документацию на уровне примитивного описания кнопок, не более. И если предметная область хоть сколько-либо сложная, то получившуюся писанину придется показывать специалисту, чтобы он нашел и вычистил все ляпы.
[/QUOTE]Надо знать не предметную область как таковую, а автоматизируемый процесс, который, как правило, покрывает только часть предметной области. Если у вас автоматизируется бухгалтерский учет коммерческой организации, это не значит, что вам нужно знать бухгалтерский учет бюджетной организации. При этом вы знаете, что такое хозоперации, проводки, дебет, кредит, т.е. общие понятия. Но если вы пойдете устраиваться в контору, которая автоматизирует бухгалтерский учет бюджетного учреждения, неужели вы долго будете изучать автоматизируемый процесс?
Понятие проводки имеет смысл описывать только в том случае, если у вас целевая аудитория - специалисты, которые занимаются разработкой ПО в вашей системе и которые действительно впервые видят проводку. Но ситуация странная, если у кандидатов при приеме на работу требуют отличного знания предметной области.
Писать бухгалтеру, что такое проводка, бессмысленно (я бы даже сказала, неуважительно). Он не будет это читать и будет пропускать ваш раздел с терминами и определениями. А если ваши термины и определения по предметной области и системе собраны в одну кучу, то возникнет ситуация, когда бухгалтер его просто пропустит, увидев, например, первое слово "амортизация".
Предметная область и тех. писатель, Можно ли знать все?
 
[QUOTE]Виктор Фигурнов пишет:
Бизнес-аналитик изучает бизнес-ситуацию, чтобы определить проблемы и возможности бизнеса,
[/QUOTE]Бизнес-аналитик этим вообще не занимается. Этим занимается специальный эксперт, который пишет бизнес-план. Бизнес-аналитик изучает потребности пользователя.
Предметная область и тех. писатель, Можно ли знать все?
 
[QUOTE]Виктор Фигурнов пишет:
Крайне сомнительно. Учет нельзя быстро изучить, прочитав нормативку, юристом нельзя быстро стать, прочитав законы, и т.д. Не знаю ни одного исключения.
[/QUOTE]А вы и не юрист, понимаете? Ваша задача заключается не в том, что объяснить юристы все "буквы закона". Ваша задача - описать, как в автоматизированной системе выполнить нужное ему действие. Или вы считаете, что если бухгалтер печатает журнал проводок, то он не знает, что такое проводка и ему необходимо рассказывать, что это такое?
Предметная область и тех. писатель, Можно ли знать все?
 
[QUOTE]Виктор Фигурнов пишет:
Специфика конкретной области может изучаться по ходу дела, но базовая подготовка должна быть. Если вы ничего не знаете о том, на основании каких документов производится отпуск товаров со склада, то основы учета вы в принципе не знаете, даже если имеете некий "опыт описания различных учетных систем". Учет это непростая область, и люди её по 5 лет в вузе изучают, а потом годы работают, и то бывает, что к ним приходят аудиторы и указывают многочисленные ошибки. А вы хотите за пару недель или месяцев освоить какую-то область учета так, чтобы правильно описывать учетные процессы и учить бухгалтеров и учетных работников тому, как им использовать программу для решения их задач. Извините, но это вряд ли получится.
[/QUOTE]Виктор, процессы УЖЕ должны быть описаны в фирме бизнес-аналитиками в аналитической документации. ТЗ как раз-таки не должно быть в виде: "разработать такую-то форму, которая должная содержать такие-то элементы". В функции технического писателя описание бизнес-процесса вообще не входит. В его функции входит описание действий пользователя в системе для достижения той или иной цели. В сложном документообороте один документ может вообще участвовать в нескольких схемах документооборота и при этом иметь разное поведение в зависимости от действий, которые необходимо с ним выполнить. Все схемы, опять же, должны быть описаны бизнес-аналитиком. Техническому писателю достаточно при налаженном процессе бизнес-анализа и документирования процессов ознакомиться с нормативкой и документацией по процессам. Если вам на собеседовании внезапно сказали, что технический писатель - это и жнец, и жрец, и на бубе игрец, то от такого работодателя надо бежать, роняя тапки, т.к. процессы разработки там на уровне примитива.
Предметная область и тех. писатель, Можно ли знать все?
 
[QUOTE]Виктор Фигурнов пишет:
[QUOTE] убожетымой пишет:
Сегодня я была на одном собесе в компанию 1С, где меня загрузили вопросами по предметным областям (бухгалтерия, экономика и т.д.). Вопросы были из серии "На основании какого документа производится кладовщиком отгрузка продукции?" И подведением итога, что я вообще ничего не понимаю и не понятно, что я могла писать без этих сакральных знаний.
Я в документации не новичок: работала и в медицине, и в "нефти", и на предприятиях-производителях. Но никто не требовал от меня знание предметной области. Получается, чтобы писать про медицинское ПО я должна была 7 лет в Меде отучиться, чтобы писать "со знанием дела"? Иначе, "это простое описание кнопочек" (цитата чела из 1С)

А у Вас как с этим? Требуют знание предметной области? Или тех. писателю теперь надо в бухгалтерских законах разбираться, чтобы про проводки писать?[/QUOTE]А как иначе? Без знания предметной области можно только про кнопки писать. О том, что видно на поверхности и понятно дилетанту. А получившуюся писанину потом специалист в предметной области должен внимательно прочесть и все ляпы выловить. Но это если важен качественный результат (у компании 1С именно такая ситуация), а не отписка для "галочки", что некий документ есть в наличии. Там, где нужна отписка, можно халтурить - писать не зная и не понимая предметной области, и лишь кое-как владея терминологией.
[/QUOTE]Но вопрос, по сути, в том, должен ли технический писатель знать предметную область уже на этапе собеседования? Или он, все-таки, должен изучать ее в процессе разработки документации?
Я считаю, что однозначно - в процессе разработки документации.
Допустим, я технический писатель, который ищет работу. За плечами опыт описания различных учетных систем. Но, вот, конкретно со складами дела не имела. Что ж теперь? Работодатель будет искать только технического писателя, который идеально знает складской учет?
Неразумно по нескольким причинам. Во-первых, в учете  любого предприятия есть свои нюансы (из опыта работы аналитиком), которые в любом случае надо изучать. Общие процессы учета как раз-таки изучаются довольно быстро, достаточно изучить нормативку. Во-вторых, технический писатель в таком случае должен быть переквалифицированным бизнес-аналитиком.
На какие вопросы должен ответить раздел (топик), описывающий работу определенного модуля в системе, разрабатываем техническую документацию
 
Для кого предназначен?
Примеры хорошей технической документации, выкладываем примеры на хорошую техническую документацию
 
[QUOTE]ADVANCED пишет:
Рисовать интерактивно только. Не как художник кистью на полотне...
[/QUOTE]Я и интерактивно рисовать не умею :)))
нумерованный список
 
Я так и не поняла, в чем проблема. Скорее всего, конфликт из-за того, что идет привязка к библиотечному стилю. В итоге, я просто переделала встроенный нумерованный стиль под себя. Работает без глюков.
нумерованный список
 
У меня сейчас та же проблема. Версия ворда - 2010. Создала нумерованный список. При задании нового начального значения списка отступы смещаются вправо. В ворде 2007 такой проблемы нет. Создание нового списка не помогает. Сейчас буду экспериментировать...
Формат и названия изображений в Help&Manual, В каком формате вы сохраняете рисунки и изображения при разработке документации в Help&Manual
 
Лучше на английском именовать. Год назад столкнулась, что при конвертации рисунки не отображались в документе из-за того, что имели русские названия. Но и HM был англоязычный. Пришлось переименовывать спешно, т.к. сроки горели. Я бы предварительно потестила конвертацию прежде, чем именовала бы на русском.
Изменено: techwriter - 26.06.2014 16:00:55
Примеры хорошей технической документации, выкладываем примеры на хорошую техническую документацию
 
[QUOTE]ADVANCED пишет:
[QUOTE] techwriter пишет:
Но некоторые разрабатывают Comics Book, в которых придуманные персонажи в виде сюжета излагают инструкции по работе с чем-либо.
[/QUOTE]Я делал однажды такую с дядей-полицейским (тогда еще милиционером) в главной роли для ГИАЦ МВД, предполагалось что старые тетки так лучше воспримут и запомнят информацию. Каков был результат не знаю.
[/QUOTE]А ты рисовать умеешь? Я, вот, нет :))
Примеры хорошей технической документации, выкладываем примеры на хорошую техническую документацию
 
[QUOTE]writer пишет:
так , а подробнее??
[/QUOTE]Например, ссылка на смешные комиксы: [url]http://www.datamation.com/cnews/article.php/3849381/Tech-Comics-The-User-and-the-Geek.htm[/url]
Но некоторые разрабатывают Comics Book, в которых придуманные персонажи в виде сюжета излагают инструкции по работе с чем-либо.
Примеры хорошей технической документации, выкладываем примеры на хорошую техническую документацию
 
[QUOTE]ADVANCED пишет:
Наверняка плохой документации больше, так что чтобы никого не обидеть, выкладываем примеры плохой документации [url=http://techwriters.ru/forum/forum598/topic19763/]сюда[/url] .
[/QUOTE]Плохую документацию почти каждый день приходится видеть :))
Вот, примеры хорошей технической документации действительно не помешает.
Мне нравятся туториалы, под которые придумывается персонаж комикса.
Предметная область и тех. писатель, Можно ли знать все?
 
Считаю, что технический писатель должен разбираться в предметной области, понимать процессы и пр. Иначе он действительно сможет написать только документацию на уровне "нажал кнопку - получил такое-то окошко". Не всегда этого достаточно. Другой вопрос, что предметная область должна изучаться уже в процессе. На то мы и технические писатели, чтобы изучать предметную область, каким образом она автоматизирована с помощью продукта.
Короче, я бы так и ответила: "На то я и технический писатель, чтобы вникать в предметную область на этапе анализа поступающей ко мне информации перед началом разработки документации. Это всего лишь учетная система, а не ракета! Поэтому разберусь в минимально сжатые сроки при необходимости!"
Разработка типовых сценариев работы с системой, Обсуждаем разработку типовых сценариев работы с системой
 
А что из себя представляет типовой сценарий работы с ПО и чем он отличается от инструкции или руководства?
Болтовня в реальном времени, Чат технических писателей, технические писатели в прямом эфире
 
Доброе утро! :)
лето началось со смены работы и покупки дачи :))
techwriter.ru.com
DITA - документация на русском языке
 
[QUOTE]TechW пишет:
Мне вот этот труд помог "DITA for Solo Writers" Louise Kasemir. Он где-то на просторах Интернета, выложила бы но не знаю как.
[/QUOTE]Спасибо! :)
Сама нашла в онлайне. начала читать, пока очень нравится. Изложение доступное, и есть понятные примеры.
Какой стандартный пакет документации Вы разрабатываете на новое ПО, Стандартный пакет документов на ПО (программное обеспечение)
 
Разрабатываемый комплект документов во многом зависит от специфики проекта. В некоторых проектах, как указали некоторые участники обсуждения, комплектность разрабатываемых указывается в контракте (договоре). Если требований к комплектности нет, то для начала необходимо спроектировать комплект.
Я бы разбивала комплект, в первую очередь, по уровню владения программой пользователем. Для начинающего пользователя логично разработать словарь терминов (глоссарий), туториалы, быстрый старт, руководство пользователя по выполнению основных типовых действий. Для опытного пользователя можно разработать подробное руководство пользователя, справочники и пр. Для продвинутых пользователей (администраторов, разработчиков) - руководство администратора (разработчика).
Стоит подумать над форматом каждого вида документа: разделить, какие документы будут в печатном виде, какие в электронном и т.д.
Заголовок топика и его текст на одном уровне, Редактор шаблонов PDF
 
[QUOTE]Kit пишет:
Теперь так. Хочу сделать текст под заголовком первого уровня без отступа слева, а под остальными заголовками - оставить с отступом. Можно?
[/QUOTE]А почему вы не пользуетесь стилями? Насколько я помню, в H&M можно редактировать и создавать стили.
Когда-то давно делала подобное оформление. Для этих целей просто вставила таблицу, состоящую из двух колонок, с "прозрачными границами" и создала стили.
Изменено: techwriter - 19.05.2014 10:46:09
Оформление кода программы в документации
 
[QUOTE]'Фрося' Фроськина пишет:
И еще вопрос. А как вы этот компакт-диск обозначаете/подписываете?
[/QUOTE]Подпись зависит от назначения и требований, по которым вы этот диск передаете. Если таких требований не существует, то они длжны быть регламентированы.
Обозначение - что имеется в виду? У каждого компакт-диска есть номер. Это и есть обозначение.
Оформление кода программы в документации
 
[QUOTE]'Фрося' Фроськина пишет:
Для работы с ним (с исходным кодом) нужна еще всякая информация и всякие необходимые вещи.
Собственно, вот как все это нужное на компакт- диск запихать, да так, чтопрограммисты спокойно восприняли - вот это у меня на повестке дня уже полгода стоит.
[/QUOTE]Не очень понятно, о какой ситуации вы написали.
И какие необходимые вещи нужны для чтения программистам?
Оформление кода программы в документации
 
[QUOTE]'Фрося' Фроськина пишет:
Т.е. если по внутренним стандартам хранение кода должно производится на компакт диске - тогда понятно (у нас - так)
Если нет, то это может быть сервер или облако))).
[/QUOTE]Причем тут внутренние стандарты?
Текст программы - это эксплуатационный документ. Поэтому подразумевается, что передается Заказчику. На чем вы передаете программный код заказчику?
Обозначение подсистем АПК, Схема деления по ГОСТ 2.711-82
 
Здравствуйте.
Не очень поняла, по какому ГОСТу вы разрабатываете схему и на каком этапе (проектирование, эксплуатация и пр.).
Болтовня в реальном времени, Чат технических писателей, технические писатели в прямом эфире
 
Цитата
ADVANCED пишет:
Куда все пропали ?
Здесь мы, здесь ;)
techwriter.ru.com
Отдыхаем!, Выкладываем фото и делимся впечатлениями об отдыхе
 
ADVANCED, здорово!
techwriter.ru.com
Страницы: Пред. 1 ... 7 8 9 10 11 12 13 14 15 16 17 След.

Рейтинг@Mail.ru