[devel] О документации

[Andrew Clark]

3 февраля 2011 г. 17:23 пользователь Андрей Черепанов <cas на altlinux.ru> написал:

>> Разумеется, предварительно составив список того, что нуждается в
>> документировании
>> прежде всего,
> Я вижу:
>
> 1. HOWTO по сборке пакета

Уже есть на вики.

> 2. Руководство по написание спека

Уже есть на вики. RPM Guide уже переведен, или есть желание Maximum
RPM перевести?

> 3. Руководство по макросам RPM

По нашим макросам я пытался составить таблицу значений - забросил.

> 4. Best practics по сборке пакетов

Возможно пригодится.

> 5. Технологии локальной сборки

На вики описано. hasher

> 6. Сборка на git.alt

Есть там же и много.

> 7. FAQ по ошибкам сборки

Наиболее частые ошибки?

> 8. Руководство по отладке и решению проблем сборки

Что-то нетривиальное туда вносить?

> 9. Описание регламентов (policy) по спекам

Уже есть - насколько актуален - не ясно.

> 10. Описание регламентов (policy) по организации сборки в Team

А эти policy есть уже?

> 11. Руководство по обновлению пакетов
> 12. Советы и секреты

Частично есть на вики.

> Есть что дополнить/убрать/переформулировать?

В целом информации на вики достаточно, просто она не структурирована.
Видимо надо
разложить ее по местам, что-то объединить, что-то дописать....

Впрочем, самое главное все равно отсутствует.


-- 
Talk is cheap, show me the code (c) Linus Torvalds