Английская лексика: Разработка программного обеспечения · Выпуск и сопровождение

Что значит documentation?

Значение и примеры · Разработка программного обеспечения

/ˌdɑːkjəmenˈteɪʃən/существительноеРаспространённый термин

documentation: документация, документация по ПО

Письменные материалы о том, как работает программа и как её использовать, настраивать или менять: руководства, справочники API и файлы README.

Где и как употребляется

Обычно сокращают до docs. Разработчики читают, пишут, обновляют документацию и дают на неё ссылки. Частые замечания: The docs are out of date и It's not in the documentation.

Примеры предложений

  1. According to the documentation, the token expires after one hour.

    Согласно документации, срок действия токена истекает через час.

    Источник указывает срок действия токена.

  2. Please update the documentation when you change the config options.

    Обнови документацию, когда изменишь параметры конфигурации.

    Описание настроек должно соответствовать изменённым параметрам.

Распространённые словосочетания

  • read the documentation
  • update the documentation
  • API documentation
  • out-of-date documentation
  • technical documentation