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

Печать RSS
207

А
Автор
Оранжевые штаны
0
Не знал в каком п/ф писать, потому не серчайте.

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

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

Добавлено через 08:23 сек.
Для ленивых - онлайн читалка http://www.viewdocsonline.com/document/awmzk6
Прикрепленные файлы:
mapbuffer.pdf.zip (64.62Kb)
Изменил: Артур (28.03.2013 / 00:57)
К

Айсберг Визави
0
Вангую, очань даже читабельно и понятно. А UML он и в Африке UML smile Мэтт Зандстра))

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

Айсберг Визави
0
Удачи тебе!
А
Автор
Оранжевые штаны
0
Благодарю
T

Пришелец
0
пользователь для тебя всего лишь программный компонент? sad
А
Автор
Оранжевые штаны
0
Для системы да, к сожалению компьютер не умеет чувствовать ))

Пришелец
0
Для меня это сложно=)
Слишком много умных слов хоть наверху и есть сноскаsmile
А
Автор
Оранжевые штаны
0
Планирую еще видеоуроки организовать чтоб было еще проще

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