nasse (nasse) wrote,
nasse
nasse

Category:
Абстрактно, пока не забылось.

Существуют три (кажется) подхода к написанию документации.

man - формализованное неизбыточное описание, как устроена эта штука. В принципе, там все есть, но разобраться может только маньяк.

howto - набор описаний, как сделать нечто полезное. Как правило, содержат все, что нужно, по наиболее распространенным случаям, но теряются тонкости, и сложно уложить в голове картину того, как эта штука устроена

траблшутер - набор описаний задниц, в которые можно попасть, с инструкциями, дающими шанс выбраться. Наиболее близко к магическому "какую кнопку жать", наиболее далеко от возможности получить хорошую модель описываемого. Но иногда срабатывает быстрее всего.

Пользователи, что характерно, не читают любой из трех вариантов документации.

UPD Наврала я. man - это не описание как устроено, а описание способов использования. Ну да, в предельном случае - полное и неизбыточное.

И как раз модель, как оно устроено, ни из одного способа документирования легко не строится.
Tags: Компьютерное
Subscribe

  • Post a new comment

    Error

    Anonymous comments are disabled in this journal

    default userpic

    Your reply will be screened

    Your IP address will be recorded 

  • 27 comments