К книге
Настоящий CTO: думай как технический директор11. Документация. 11.3. Документы для публикации (whitepapers)
80%
11. Документация. 11.3. Документы для публикации (whitepapers)
264

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

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

В них не должно содержаться коммерческой тайны или подробного описания технологии. Цель здесь – познакомить читателя со стороны с вашим ходом мыслей, чтобы ему было легче взаимодействовать с продуктом. Вот что можно описать:

• Принципы безопасности API.

• Рекомендации по работе с данными.

• Рекомендуемые методы работы при интеграции API.

• Жизненный цикл данных.

Предыдущая главаГлава 264 из 332Следующая глава