Внимание! Мы обновляем сайт! Все для технического писателя и разработки технической документации. Внимание! Мы обновляемся!

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

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Выбрать дату в календареВыбрать дату в календаре

Страницы: 1 2 3 4 5 6 7 8 9 10 11 ... 14 След.
Скачать word 2007, где скачать торрент или программу word 2007
 
Люди!! Поможите!!
После 7 лет работы убился мой woord 2007!  Была корпоративная версия. Ставил на все свои компьютеры. После сноса системы, удалилась папка со всеми программами, в том числе и моим любимым word 2007!! ААА! У кого-нибудь есть ключ, дистрибутив,  ссылка или что-нибудь!! Как быть техпису без worda не знаю )) Неизвесатные торренты боюсь скачивать, компьютер без антивируса стоит.
Изменено: puhata - 04.05.2018 17:22:50
Как вы начинаете разрабатывать пользовательскую документацию? Содержание документа Руководство пользователя, Содержание документа, планирование содержания пользовательской документации
 
Цитата
Виктор Фигурнов написал:
Решать надо на основе ГОСТ Р ИСО/МЭК 15910—2002 "Процесс создания документации пользователя программного средства"
Виктор, а можно подробнее? В этом ГОСТ, описывается как создавать структуру документа?
Очепятки, смешные инструкция, добавляем найденные опечатки, о том как не нужно писать
 
Вот еще вопрос во Внукове или во Внуково?



 
интерактивные документы, программы...
 
Это как у Гарри Поттера волшебная газета)
Форум по Help&Manual стал официальным форумом поддержки русскоязычных пользователей!
 
Мои поздравления!
vostorg-smile
Какая замечательная погода!
 
Солнышко светит, настроение отлично! Не нарадуюсь февралю в этом году)) +:6 и все тут! Вот такие бы зимы были у нас всегда!
Визуальный редактор XML-файлов, для работы с технологией Docbook
 
Docbook еще жив?
При публикации проекта help-справки (CHM) не сохраняются ключевые слова
 
спасибо!
При публикации проекта help-справки (CHM) не сохраняются ключевые слова
 
Для того, чтобы в определенном окне приложения выходили связанные разделы в опциях темы help manual должны быть прописаны ключевые слова. у меня они прописаны, но при публикации почему то не сохраняются в готовом проекте. В чем загвоздка может быть?
А-ключевые слова в Help&Manual, Что такое А-ключевые слова в Help&Manual
 
спасибо
А-ключевые слова в Help&Manual, Что такое А-ключевые слова в Help&Manual
 
вот так, а я думал "смотри также" ручками прописывают. Но все равно не понял как с ними работать в Help&Manual
А-ключевые слова в Help&Manual, Что такое А-ключевые слова в Help&Manual
 
В опциях топика Help&Manual есть просто "Ключевые слова" и "А-ключевые слова" чем они отличаются?
10 самых смешных слов русского языка, 10 самых смешных слов русского языка
 
Цитата
sonriza пишет:
Я из этих слов только 4 знаю: Бонбоньерка, Размокропогодиться, Балясина, Курвиметр  :oops:
неплохой словарный запас, я ни одного не знаю
Нужно ли писать в чате грамотно?
 
а нас обязали писать правильно, этакое самодурство начальника, типа техпис, вот и пиши правильно   :( . перестал общаться по чату или говорю "да" "нет"
Изменено: puhata - 02.10.2014 10:27:49
С чего начать при написании Руководства программиста?
 
Руководство программиста от философта


Цели и задачи

Руководство программиста разрабатывают в трех случаях:
программный продукт по своему основному назначению является средой разработки или библиотекой (как Delphi или Qt);
комплекс или программный продукт служит платформой для разработки программ или систем определенного типа (как 1С или Axapta);
программа распространяется вместе с исходным кодом или постоянно модифицируется самими разработчиками.
Наверняка можно представить себе и другие ситуации (например, программный продукт является операционной системой), но в жизни они встречаются значительно реже.
Очевидная задача руководства программиста — снабдить разработчика информацией, которой ему будет достаточно для создания на базе нашего программного продукта собственных программ или систем. Еще один мотив создания такого документа — потребность разработчиков время от времени фиксировать состояние продукта, чтобы самим в нем не запутаться и не плодить в коллективе носителей «сакральных знаний».

Содержание документа


Руководство программиста должно объяснять:


Как устроен «мир», в который погружают разработчика. С какими объектами программист имеет дело, где они находятся, сколько времени существуют и как они взаимодействуют между собой. Какие из них он создает сам, а какие предоставлены ему изначально средой, фреймворком, библиотекой.
Какие еще средства разработки (кроме нашего программного продукта) необходимы для того, чтобы создать приложение или систему. Например, если наш программный продукт — это библиотека, то программисту потребуются компилятор (возможно, вполне определенный), какая-то среда разработки и прочий инструментарий.


В какой среде функционирует приложение или система? Какими будут его минимальные требования к системе? Понадобятся ли для его запуска какие-либо дополнительные программные средства: фреймворки, рантаймы, интерпретаторы.


Что представляет собой минимальное работоспособное приложение или минимальная работоспособная система. Какие объекты в какой последовательности необходимо создать, и как их друг с другом соединить, чтобы приложение вывело хотя бы «Hello World». Правда, бывают приложения, которые вообще не выводят текста, а управляют доменной печью или трафиком в сетях, но у них все равно обязательно есть какой-то свой минимальный вывод.


Как (по шагам) скомпилировать работоспособное приложение или развернуть работоспособную систему.
Это основные вопросы, без ответов на которые программист не сможет нормально работать. Если не сообщить их ему в явном виде, он будет вынужден заняться исследованиями. Но есть еще много дополнительных: методика и техника отладки, стиль программирования и др.
Кроме теории руководство программиста должно содержать полные описания всех предусмотренных в программном продукте объектов. Если это функции, то должны быть приведены их синопсисы, если классы, то описания их интерфейсов и т. д.
Если программный продукт предполагает использование оригинального языка программирования и снабжен собственным компилятором или интерпретатором, в руководство программиста необходимо включить его описание. Однако, если оно получается достаточно объемным, его выносят в отдельный документ, который так и называется: описание языка (программирования).


Методика и стиль изложения


Важнейшие методические требования к теоретической части руководства программиста — логичность и последовательность изложения. В частности, в тексте обязательно должны быть соблюдены следующие правила:
При вводе нового понятия мы опираемся только на те понятия, которые были введены ранее явно или считаются заведомо знакомыми читателю. Как в учебнике математики.
У читателя никогда не должно возникать ощущение, что автор плодит сущности без надобности. Ввод каждого понятия должен быть чем-то обоснован.
Основное требование при описании отдельных объектов — полнота описания каждого из них. В отличие от руководства пользователя, при составлении которого в принципе можно рассчитывать на догадливость читателя, который поглядит на интерфейс и сам разберется, руководство программиста описывает весьма неочевидные вещи. И хотя от программиста можно ожидать большей догадливости, чем от пользователя, восполнять недостаток информации ему придется анализом исходного текста, а если он доступен, то тестированием «черного ящика» и отладчиком. Это намного более долгий процесс, чем «блуждание» по меню и диалоговым окнам.


При описании объектов особое внимание следует уделять следующим аспектам:
  • Что обязательно должно предшествовать созданию и использованию объекта.
  • Каковы побочные эффекты обращения к объекту.
  • Особенности интерпретации объектом передаваемых ему данных.
  • Где «физически» (в каком файле, в какой библиотеке) находится объект.
Желательно по каждому объекту привести примеры использования, небольшие фрагменты кода, демонстрирующие:
  • создание объекта (если перед использованием его необходимо создать);
  • передачу объекту входных данных;
  • получение выходных данных и их интерпретацию.
Описания объектов можно вынести в отдельный том или документ под названием «Справочник программиста». Хорошая мысль — сделать его гипертекстовым.
Между теоретической частью и справочником по объектам полезно поместить небольшой раздел, в котором рассматривается пример небольшого, но полноценного, с точки зрения используемой платформы, приложения. Пример должен быть таким, чтобы читатель смог самостоятельно это приложение воспроизвести, отладить и запустить. Очевидно, для этого сначала все это должен проделать кто-то из авторов руководства программиста.

Типовая структура руководство программиста

Структура руководства программиста, зафиксированная в ГОСТ 19.504-79, такова:
  • Назначение и условия применения программы.
  • Характеристика программы.
  • Обращение к программе.
  • Входные и выходные данные.
  • Сообщения.

Полноценное руководство программиста может быть написано только автором, имеющим собственный опыт профессиональной разработки программ.
Руководство программиста может комплектоваться различными схемами, например, схемами базы данных, диаграммами классов, графами вызова функций.
Ищу работу техническим писателем
 
Звучит понятно, а по зп плюс минус какой?)) Да и территориально где?
Изменено: puhata - 07.03.2014 14:29:30
С Праздником Весны! Ура!
 
И от меня всех девушек с праздником!! Вы такие красивые и славные все!!Что бы мы без вас делали!


Ищу работу техническим писателем
 
можно рассмотреть)
Ищу работу техническим писателем
 
Ищу работу техническим писателем
Детализация разделов документациипо ГОСТ
 
Вот сами себе и ответили) :)  Все правильно
Главная страница
 
Абсолютно забыты ГОСТы, я бы добавил это в оглавление чтобы не забыть. И виды документации расширить нужно (Пояснительная записка, ТЗ, и т.д. все что по ГОСТам нужно)
Изменено: puhata - 13.02.2014 15:40:18
История изменения топиков, Как в H&M 6 очистить историю изменений топиков
 
там где-то должнен быть флажок Automatically start calculating его нужно убрать. Это смотря какая версия, одно время у них отсутствовала эта функция и очистить не было возможности, потом вроде как исправили
Изменено: puhata - 29.03.2013 01:10:31
Выбор XML CMS для организации документации DITA
 
Цитата

Непонятно, что за "CMS для работы с Dita и Docbook". ЧТО НАДО ДЕЛАТЬ с Dita и Docbook в системе CMS и как она должна выглядеть?
Давно это было, но помню я имел ввиду некую Программную оболочку, которая позволяет работать с технологией Dita
Тестируем новый форум, Все замеченные на форуме ошибки выкладываем здесь. Будем искать, разбираться и исправлять. Всем спасибо за помощь!
 
Ссылки внутри форума слетели все, нужно править. Форум уже начинает походить на что-то вменяемое  :)   И не понятно с системой рейтингов и балов - это что такое?
Изменено: puhata - 26.03.2013 09:54:48 (Выпил лишнего)
Тестируем новый форум, Все замеченные на форуме ошибки выкладываем здесь. Будем искать, разбираться и исправлять. Всем спасибо за помощь!
 
и файлы не загружаются
Страницы: 1 2 3 4 5 6 7 8 9 10 11 ... 14 След.