Описание тега documentation

Описание тега Вопросы с тегом

ЭТА ТЭГ ПРЕДНАЗНАЧЕН ТОЛЬКО ДЛЯ ГЕНЕРАТОРОВ ДОКУМЕНТОВ. Включите также язык и / или тег SDE. НЕ ИСПОЛЬЗУЙТЕ, чтобы запрашивать ссылки на документацию или инструменты, или чтобы критиковать документацию поставщика.

Используйте тег документации для вопросов, связанных с самодокументированным кодом и генераторами документации.

Основные определения

Документация по программному обеспечению - это письменный текст или иллюстрация, которые прилагаются к компьютерному программному обеспечению или встроены в исходный код. Он либо объясняет, как он работает, либо как его использовать, и может означать разные вещи для людей в разных ролях. ^{Википедия}
Генератор документации является инструментом программирования, который генерирует документацию по программному обеспечению, предназначенный для программистов и конечных пользователей, или оба из набора специально комментировал файлов исходного кода, а в некоторых случаях, бинарные файлы. ^{Википедия}

Связанные теги

Возможные синонимы:

генерация документов - синоним документации
code-documentation - документация внутри кода, объясняющая его функции и использование.
руководство - как в "Руководстве пользователя"

Подставим эти более конкретные теги для документации, где это возможно:

javadoc - Инструмент создания документации для java.
doxygen - инструмент для создания многоязычной документации.
python-sphinx - Инструмент для создания документации на Python, адаптируемый к другим языкам.
jsdoc, jsdoc3 - Инструменты создания документации для javascript.
rd, roxygen2 - Инструменты генерации документации для r.
xml-documentation - разметка XML-документации для C#.
springfox - Набор из ява библиотек для автоматизации генерации машины и читаемых спецификаций для человека JSON API, написанной с использованием пружинного каркаса.
ярд - Инструмент генерации документации для ruby.
haddock - Инструмент для создания документации для haskell.
phpdocumentor2 - Инструмент создания документации для php.
rustdoc - Инструмент создания документации для ржавчины.
kotlin-dokka - Инструмент создания документации для kotlin.

Темы "документации" на других сайтах SE

Вопросы о том, как документация вписывается в процесс разработки программного обеспечения, не относятся к теме Stackru, но относятся к теме разработки программного обеспечения.

Написание Stack Exchange имеет теги для технического написания, документации API и программных инструментов, с акцентом на ремесло профессионального письма.

Полезные ссылки

Начиная? См.: Google - Как писать пользовательскую документацию.
Ищете инструмент? См.: Википедия - Сравнение генераторов документации.
Хотите узнать о рекомендуемых стилях? См.: Google - Руководства по стилю.

Вопросы вне темы

Помните, что следующие типы вопросов не относятся к теме и могут быть закрыты и удалены:

Где документация для...?
Как лучше всего задокументировать...?
Есть ли инструмент для документирования...?
Эта документация верна?