понедельник, 28 февраля 2011 г.

Впечатления о документации на V-Ray

Вообще-то говоря, оригинальная документация на V-Ray написана отвратительно.
  1. Документация писалась программистами, а не техническим писателем. Поэтому иногда страдает излишним лаконизмом: часто описан некий параметр, но нет указаний для чего он служит, как им пользоваться и какой диапазон значений имеет практический смысл.
  2. Документация писалась не одним человеком, а коллективом авторов. Это чувствуется как по стилю языка, так и по степени подробности информации.
  3. Коллектив авторов, по-видимому, болгары. Т.е. английский для них - не родной язык. Поэтому иногда текст смахивает на этакую феню, которую можно встретить на англоязычных форумах, когда программер из Пакистана пытается объяснить свою проблему программеру из Китая.
  4. ...и рука корректора конечно не прикасалась к тексту. (Надо сказать, что мой перевод тоже не правился корректором. Но мне - простительно: это мой личный проект, а у них (Chaos Group) - это официальная документация к коммерческому продукту.)
  5. Встречаются недописанные статьи. Пример: статья примеров к фотонной карте. Я даже переводить этот огрызок не стал. Иногда недостает картинок.
  6. Достаточно часто в документации для "новой" версии V-Ray остаются неотредактированные статьи от "предыдущей" версии, которые потом на оригинальном сайте потихоньку приводятся в соответствии с текущей версией. Это - надо сказать, самое пакостное свойство всей документации. Очень неприятно выискивать обновленные статьи, а в них выискивать те два абзаца (или два слова), которые были изменены. Это же относится и к иллюстрациям, показывающим пользовательский интерфейс.
  7. Попадаются статьи-рудименты. Они безнадежно устарели и не имеют вообще никакого смысла в контексте текущей версии V-Ray, но где-то в недрах документации есть одна ссылочка на такую статью - и статья остается в составе документации.
 А поскольку проект Vraydoc - это перевод, по возможности близкий к оригиналу, то многие недостатки исходного текста унаследовал и перевод.

Комментариев нет:

Отправить комментарий