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