[sisyphus] Документация alterator для самых маленьких

[Eugine Kosenko]

2014-12-28 20:01 GMT+03:00 Michael Shigorin <mike на altlinux.org>:

> Можно поставить alterator-standalone и нужные модули,
> запустить от рута acc и посмотреть.
>
> > Вообще, как я вижу, хорошей документации по альтератору в стиле HOWTO по
> > конкретным вопросам (типа как у меня), похоже, вообще нет.
>
> Давай исправлять, если хочешь.  Свежий взгляд ещё без привычки --
> самый ценный в плане документирования.
>

Ну вот, Миша, ты дал ценный совет, после которого лично для меня alterator
превратился из груды скриптов в полезный инструмент.

Возьмем, например, хотя бы, документацию из alterator-doc. в ней в корне
всего лишь два каталога --- internals и samples. Но внутренности меня, как
новичка, пока не интересуют. А в примерах --- только образец разработки
бэкенда, который меня, опять же, как новичка только пугает. Может, было бы
полезно завести дополнительно каталог, например, usage для тех, кто только
использует альтератор, но не разрабатывает под него?

Дальше, если взять, например. internals/index.html (как я понял, его
web-копия находится здесь:
http://freesource.info/wiki/AltLinux/Sisyphus/Alterator). Здесь об acc не
сказано ни слова. Немного есть об fbi, но в самой середине документа. Это
тоже нужно догадаться, что новичкам лучше начать отсюда. Ну и вообще везде
доминируют вопросы разработка, а не использования альтератора.

Может, хорошим началом для usage/index.html стала бы короткая справка по
запуску acc и fbi.

Как-то так... Это всего лишь мысли вслух, их можно будет, при наличии
времени и денег даже как-то оформить...
----------- следующая часть -----------
Вложение в формате HTML было удалено...
URL: <http://lists.altlinux.org/pipermail/sisyphus/attachments/20141229/12e61dcd/attachment.html>