Как написать документацию к проге? - есть ответ

Ответы:

orie

1. Определиться с типом документа и таргет-группой
2. Выбрать или выработать стандарт
3. Провести сбор информации. Тут могут быть разные варианты:
- Если документация по интерфейсу, то самостоятельно пройтись по всем разделам интерфейса. Непонятное спросить у программистов.
- Если документация по исходникам, то взять за грудки программистов и пусть рассказывают, что оно умеет делать и зачем
4. Написать план или черновик, охватывающий общую структуру документа.
5. Написать содержательную часть, уточняя непонятные вещи у программистов
6. Написать служебные разделы - глоссарий, введение и т.п.

17 лет назад

RPI.su - самая большая русскоязычная база вопросов и ответов. Наш проект был реализован как продолжение популярного сервиса otvety.google.ru, который был закрыт и удален 30 апреля 2015 года. Мы решили воскресить полезный сервис Ответы Гугл, чтобы любой человек смог публично узнать ответ на свой вопрос у интернет сообщества.

Все вопросы, добавленные на сайт ответов Google, мы скопировали и сохранили здесь. Имена старых пользователей также отображены в том виде, в котором они существовали ранее. Только нужно заново пройти регистрацию, чтобы иметь возможность задавать вопросы, или отвечать другим.

Чтобы связаться с нами по любому вопросу О САЙТЕ (реклама, сотрудничество, отзыв о сервисе), пишите на почту [email protected]. Только все общие вопросы размещайте на сайте, на них ответ по почте не предоставляется.