Корпоративная ответственность: наши планы по борьбе с недостоверной
информацией
-
*Нил Мохан, директор по продукту YouTube *
Миллиарды людей во всем мире заходят на YouTube по самым разным причинам,
например, чтобы посмотреть редкую за...
2 года назад
9 комментариев:
следующий вопрос: генерация документации по коду (инструменты типа SandCastle, Doxygen, NDoc) - дела давно минувших дней (вопросы по этой теме идут лесом), или приходится / приходилось сталкиваться недавно (тогда будут по этой теме)?
+ вопрос: существует ли более умный способ вести документацию на 2х языках (здесь речь просто про текст), чем просто вести 1 doc файл, разделенный на 2 колонки, и потом в финале разбрасывать на два файла?
чем пользовалась реально?
Ответ на первый вопрос: Правильно ли я поняла, что имеется док, в нем на двух языках один и тот же текст. После завершения оттуда ты берешь нужные куски. Сразу скажу, что таких ситуаций у меня не было - двуязычия документации. Пока в оффшоре работала, писала только на англ., там русский не требовался, а впоследствии - только на русском. Возвращаясь к вопросу: на мой взгляд, а куда проще (умнее)? Если так работать удобно, ну и синхронизируй куски текста в одном файле, по крайней мере, все время перед глазами сравнение есть для возможной корректировки. А какие варианты, если подумать? Автопереводчик косячит по-любому... Хотя... я, может, просто не поняла вопрос?
Второй вопрос, похоже, в лес :( Поскольку в последнее время не занималась документированием исходного кода вообще, другие задачи жить спокойно не дают: пишу типично юзерские документы по типично советским ГОСТам. Работа такая. Так что если вопросы из этой сферы будут - welcome :), ибо поднаторела...
>Правильно ли я поняла
правильно
>Если так работать удобно
а я еще реально не пробовал, только примериваюсь к ситуации.
но сразу показалось, что в теории можно сделать и поудобнее инструмент, чтоб синхронизировался по фразам/по предложениям, а не самому взглядом выцеплять.
наверняка уже есть. ну да ладно.
> Вы сейчас доки делаете на основе единого источника? Если да, то каким
> инструментом? Я в процессе сравнения-выбора, вот мне и интересно.
уточни вопрос. просто я недавно занялся документацией, и пока только документацией по коду.
из твоего "не занималась документированием исходного кода вообще" видимо это вопрос "не по коду"
есть еще 2 девушки на документации, одна из которых в декрете :-), если вопрос пойму - переспрошу.
Спроси, пожалуйста, с помощью каких инструментов ваши техписы разрабатывают пользовательскую документацию, ладно? Есть чудные тулы, работающие по принципу единого источника, это когда, грубо говоря, в одном месте пишешь куски текста, а потом автоматом разбрасываешь их в разные форматы, мне, например, надо pdf, doc, htm. Прелесть в том, что правки вносишь в одном месте, а актуализируются они одновременно во всех выходных форматах. А грусть в том, что такие тулы либо стоят, как авианосцы и кряков нет :(, либо каким-то углом мне не подходят. Вот и ищу... с перламутровыми пуговицами.
Serna Free 4.3,
плюс нечто самописное для компиляции в CHM
//сорри за задержку с ответом на вопрос.
02-09 10:11 test comment
Отправить комментарий