14.06.2017  Экспертиза, Открытый код/Linux

Хорошая документация играет решающую роль в открытом проекте. Это подтверждают как многочисленные эксперты, так и результаты проведённого GitHub исследования, в котором 93% респондентов отметили важность этой составляющей. Очевидно, что основная сложность написания документации заключается в том, что она должна быть не только полной, но и разнообразной. Технический писатель Red Hat Роберт Кратки на сайте OpenSource.com рассказывает об одном из возможных способов решения этой проблемы. Есть множество подходов к написанию документации, но все они так или иначе могут быть отнесены всего к двум категориям: описание возможностей продукта; описание действий, необходимых для решения конкретных задач. Оба подхода используются на практике даже в рамках одного проекта, поскольку ориентированы на различную аудиторию ... читать далее.