Разработка технической документации и технические писатели Технические писатели и разработка технической документации технические писатели в Телеграм 

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
Ответить
RSS
Попробуйте LaxModules 0.1 для Word, Если повезёт, будет не-CMS для инженеров
 
LaxModules
http://laxmodules.com/
  • Несколько руководств из одного документа
  • Исходный документ содержит всё, LaxModules удаляет лишнее
  • LaxModules полезен инженерам, ответственным за техническую документацию


Тут форум техписов, а не инженеров. Но надеюсь, что последние сюда тоже заходят, и могут подсказать:

  • в какую стороны развиваться,
  • готов ли кто купить,
  • где русские инженеры общаются, что читают: форумы, рассылки, печатные газеты
Сейчас для меня самое главное -- это тестирование. Существуют разнообразные версии Windows и Microsoft Word. Возможно, при каких-то их комбинациях программа не работает.

Я буду рад, если кто-то попробует и напишет впечатления. Ругать можно спокойно, к критике я привык.
Изменено: 'Oleg' Parashchenko - 02.08.2013 14:43:25 (подправил картинку)
 
а вы подробнее опишите для чего эта программка нужна. Что делать умеет, зачем ее нужно использовать, что на выходе получаем?
 
Цитата
'Oleg' Parashchenko пишет:
Исходный документ содержит всё, LaxModules удаляет лишнее
Прам таки удаляет или просто не использует?
 
Цитата
''writer'' пишет:
а вы подробнее опишите для чего эта программка нужна. Что делать умеет, зачем ее нужно использовать, что на выходе получаем?
"Глаз замылился". То, что надо бы описать, кажется настолько очевидным, что даже в голову не приходит. Надеюсь, за несколько попыток получится.

Маленькая фирма придумала прибор для измерения богомипсов. Прибор хороший. Появляется всё больше и больше заказчиков.

Однажды новый клиент спрашивает: хочу, чтобы результаты измерений отображались римскими цифрами. Не вопрос, за хорошую оплату можно сделать. Но даже менеджер догадается, что такое изменение не нужно вносить в базовую модель. Так из одного прибора получается серия приборов. Пока что из только двух моделей, ПРИБОР и ПРИБОР-РИМ.

Как там насчёт документации для ПРИБОР-РИМ? Просто скопировать ПРИБОР.doc в ПРИБОР-РИМ.doc и подправить как надо? Можно и так. Но инженер знает, что текст пойдёт корректору на вычитку, и его изменения должны оказаться в обоих описаниях.

Инженер подумал-подумал и решил, что такое решение для документации съест меньше всего времени и усилий:
  • Переименовал ПРИБОР.doc в ПРИБОР-СЕРИЯ.doc.
  • Добавил особенности РИМ в документ ПРИБОР-СЕРИЯ.doc, причём новые тексты оградил абзацами "BEGIN РИМ" и "END РИМ".
  • Отправил ПРИБОР-СЕРИЯ.doc корректору.
  • Получил результат. Закоммитил в Subversion.
  • Когда пришло время сдавать документацию:
  • -- скопировал ПРИБОР-СЕРИЯ.doc в ПРИБОР-РИМ.doc. Одно описание готово.
  • -- скопировал ПРИБОР-СЕРИЯ.doc в ПРИБОР.doc.
  • -- Прошёлся по файлу ПРИБОР.doc, удалил все BEGIN-END-блоки. Второе описание готово.
Прошёл год. Новый клиент. Хочу прибор с розовым корпусом в форме котёнка  :{} . Инженеры что-то сказали, но сделали. При этом внутренняя компоновка изменилась, и документацию надо подправить.

Как это делать, уже ясно. Взяли ПРИБОР-СЕРИЯ.doc, который, кстати, за год сильно изменился. Добавили описания. Ограничили их абзацами "BEGIN КОТЁНОК" и "END КОТЁНОК". То, что неверно для котёнка, заключили в "BEGIN ОСНОВА" и "END ОСНОВА".

Итак, теперь ПРИБОР-СЕРИЯ.doc содержит такие варианты: ОСНОВА, РИМ и КОТЁНОК. Из этого общего описания можно сделать документацию для таких приборов:

* ПРИБОР просто
* ПРИБОР с римскими цифрами
* ПРИБОР в виде розового котёнка
* бонус: ПРИБОР с римскими цифрами и в виде розового котёнка

Единственная проблема, что хотя удалять варианты просто, это всё-таки ручная работа. LaxModules автоматизирует задачу.
 
Цитата
'''ADVANCED''' пишет:
Цитата
'Oleg' Parashchenko пишет:
Исходный документ содержит всё, LaxModules удаляет лишнее
Прам таки удаляет или просто не использует?
Оба утверждения верные. На примере прибора из предыдущего ответа.

ПРИБОР-СЕРИЯ.doc не изменяется. Можно считать, что "лишние тексты" не используются.

Из общего описания получается, например, ПРИБОР-РИМ.doc. В нём "лишние тексты" удалены.
 
Мне это не подойдет )
Во-первых, два раза перечитал чтобы понять в чем фишка, но так и не понял.
Во-вторых, как-то не правильно копировать файл и удалять из него что-то, тем самым плодить миллион похожих файлов. А уж тем более хранить бинарники в Subversion.  Subversion не для того создавался.
 
Цитата
'''ADVANCED''' пишет:
Во-первых, два раза перечитал чтобы понять в чем фишка, но так и не понял.
  • Непонятен сам текст, или
  • непонятна фишка?

Цитата
Во-вторых, как-то не правильно копировать файл и удалять из него что-то, тем самым плодить миллион похожих файлов.
Раньше я тоже так думал. Но за два дня активной ругани, один умный человек меня переубедил. Для некоторых проектов важно именно сделать копию и работать с ней. Затем я придумал замечательную аналогию для программистов. Разработчик сохраняет код в trunk (терминология систем контроля версий), или же делает branch для проекта, и работает в отдельной ветке.

Это очень важное открытие. До него я гадал, почему у ГлавногоЗаказчика провалилось внедрение многомиллионной CMS, и почему она такая "кривая". Сейчас понимаю. Программисты не догадываются о возможности сделать branch, а заказчик не может объяснить, что ему надо. В итоге вместо простого решения -- более-менее умная копия файла -- появляется ужасная помесь trunk и надстроек.

Но это всё -- философия.

Цитата
А уж тем более хранить бинарники в Subversion. Subversion не для того создавался.
Согласен, но против пользователей идти бесполезно.
Страницы: 1
Ответить
Читают тему
Форма ответов
Текст сообщения*
Загрузить файл или картинкуПеретащить с помощью Drag'n'drop
Перетащите файлы
Ничего не найдено
Загрузить файлы
Отправить Отменить