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

Переход на DITA: проблемы и их решения

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

 Зарегистрируйтесь
   RSS
Переход на DITA: проблемы и их решения
 
Интересная и полезная статья, о том, что нужно знать и какие ошибки не допустить при переходе на Dita

Вот и настал тот момент, когда мы решили переходить на диту. Точнее, мы ничего не решали – за нас все решили. Появился новый менеджер, сделал красивую презентацию и убедил всех в том, что дита спасет мир. Я не спорю… технология сама по себе отличная. Вопрос в том, что перевести 4 огромных проекта на диту одновременно, в условиях нашей компании, невозможно. Точнее возможно, но понадобится нам на это лет так…5. Это только для того, что бы достигнуть того уровня документации на котором мы сейчас находимся, то есть, чтобы сделать что-то лучше нужно еще пару лет накинуть. И вопрос не в том, что дита плохая…нет. Просто переходить на нее надо с умом. История длится уже 3 месяца и до дедлайна у нас еще есть месяцев 8. На данный момент:
  • Мы потеряли ссылки между топиками
  • Мы потеряли видео в файлах
  • Мы больше не поддерживаем имиджмепы
  • Мы создали уже 20000 xml файлов, которые нужно будет как-то поддерживать, и это только описание интерфейса
  • Мы не поддерживаем свой css
  • Мы имеем целую кучу файлов, содержащих только таблички и процедуры, которые, вероятнее всего, никто никогда читать не будет
  • Мы потеряли контекстный вызов хелпа
  • И, лично я, имею целую кучу вопросов на которые мне никто не может ответить.
Для тех, кто стоит на пороге принятия решения о переходе на эту технологию, еще раз хочу заметить, что проблема не в самой дите, а в том каким образом мы на нее переходим. Пожалуй, могу перечислить несколько пунктов, которых неплохо было бы придерживаться при конвертации в диту:
  • Определитесь зачем вы это делаете и что вы выигрываете с этим переходом.
  • Не пытайтесь перевести все проекты одновременно.
  • Подумайте о том, что при переходе на диту 60% работы. должны выполнять программисты. Одним текрайтерам не справится.
  • Убедитесь, что в компании есть хотя бы один человек, который действительно знает, что такое дита.
  • Не пытайтесь создать что-то с нуля. Используйте, ту документацию, которая у вас уже есть.
  • Наймите побольше студентов для монотонной работы.
К сожалению, мы не соблюдали ни один из вышеперечисленных пунктов, и поэтому уже на самой начальной стадии у нас очень много проблем. Эта история только началась, но конца ей пока не видно.
Страницы: Пред. 1 2
Ответы
 
Текрайтер из Питера, меня не то чтобы заботит, но просто интересно, что это и как работает, учитывая, что я ничего не делаю, а значения в этих полях растут.
"Хочется быть авторитетной" - это я ради шутки написала, извините.

Город Петербург.
 
Цитата
Sofya написал:
 Текрайтер из Питера , меня не то чтобы заботит, но просто интересно, что это и как работает, учитывая, что я ничего не делаю, а значения в этих полях растут.
"Хочется быть авторитетной" - это я ради шутки написала, извините.

Город Петербург.
Я вам отписался на почту через форум. Если получили сообщение - дайте знать также почтой.
 
Цитата
Sofya написал:
Город Петербург.
Это прекрасно :) Можно пересечься на каком-нибудь глобалмитапе или на встрече техписов.
 
Elena, будет прекрасно, если я еще буду понимать о чем речь :-) Для этого надо быть хоть немного в курсе технологий документирования, а у меня пока поверхностные разрозненные сведения. Но глаза боятся, а руки делают!
 
И как успехи?
 
Да пока никак :-( пыталась разобраться - но это тьма тьмущая. Тут итак много работы по организации разработки документации (стайлгайд, например, типовые доки, описание всяких процессов по разработке доков и пр.), поэтому переключилась на неё, а DITA передала девушке, которая вроде программист и которая знает прогера, который вроде может в этом разобраться, но пока ни ответа, ни привета, поэтому делаю текущую работу, а там, может, заберу обратно диту...
А в связи с последним гипербатоном яндекса узнала о новой системе, думаю, может её лучше поизучать и попробовать внедрить, если, опять же, получится. По крайней мере, там вывод в ворд без проблем.
А еще думаю попробовать из конфлюенс соорудить что-то вроде ТЕИ - с помощью макросов, тегов, запросов и пр. Посмотрим, что выйдет...
 
writer, но спасибо за проявленный интерес :-)

Текущую тему, думаю, можно закрывать.
 
Да, тема актуальная достаточно. Может кто-то продолжит. Посмотрим.
Цитата
узнала о новой системе
А что за система?
Страницы: Пред. 1 2
Читают тему

Рейтинг@Mail.ru