Документация

1. Артур (28.03.2013 / 00:57)
Не знал в каком п/ф писать, потому не серчайте.

Доброго времени суток.
Начал документировать свою систему, но хотел бы спросить, достаточно ли понятен выбранный мной формат документирования? В следующем посте я прикреплю файл с документацией одного класса и прошу вас оценить, насколько вы поняли его прочитав документацию. Что в ней лишнее (и почему), а что стоило бы добавить (и почему).
Заранее благодарен

Добавлено через 01:22 сек.
Вот сам файл

Добавлено через 08:23 сек.
Для ленивых - онлайн читалка http://www.viewdocsonline.com/document/awmzk6

2. Кевин Митник (28.03.2013 / 01:44)
Вангую, очань даже читабельно и понятно. А UML он и в Африке UML smile

Мэтт Зандстра))

Добавлено через 06:04 сек.
И да, а для кого пишешь? Если для нас, обычных пользователей, то информации достаточно, а вот если тебе пришлось бы читать такую документацию? Лишнее наверняка есть. К чему веду, может small descr и big?)) Как-то так))

3. Артур (28.03.2013 / 01:54)
Для обычных пользователей пишу. Хочу гибкую, понятную, русскую, GNU GPL систему с клиент-серверной архитектурой начеркать

4. Кевин Митник (28.03.2013 / 16:17)
Удачи тебе!

5. Артур (28.03.2013 / 22:07)
Благодарю

6. Tadochi (01.04.2013 / 06:29)
пользователь для тебя всего лишь программный компонент? sad

7. Артур (02.04.2013 / 12:28)
Для системы да, к сожалению компьютер не умеет чувствовать ))

8. Даниил (02.04.2013 / 14:15)
Для меня это сложно=)
Слишком много умных слов хоть наверху и есть сноска smile

9. Артур (05.04.2013 / 21:58)
Планирую еще видеоуроки организовать чтоб было еще проще

Добавлено через 00:28 сек.
А вообще система не простая, потому и приходится много документации писать

URL: https://visavi.net/topics/37285