Описание методов API в Confluence В этой главе докладчик обсуждает важность описания методов API и то, как это может сэкономить время и обеспечить лучшее понимание системы. Документируя API-интерфейсы, разработчики могут легко обращаться к ним при необходимости вместо того, чтобы копаться в коде. Это также облегчает сотрудничество между командами.
Преимущества рефакторинга и документирования кода "Рефакторинг" относится к реструктуризации существующего кода без изменения его внешнего поведения. Спикер объясняет, что при правильном документировании API и поддержании их описаний будущие изменения или миграции становятся намного проще, поскольку разработчики имеют четкое представление о том, как работает каждый метод. Кроме того, наличие хорошо документированного кода снижает зависимость от людей, которые изначально его разрабатывали.
Сетевые взаимодействия Докладчик подчеркивает, что сетевые взаимодействия - это не просто взаимодействия на уровне компонентов, а скорее комплексные системы с множеством вариантов реализации. Описание этих взаимодействий имеет решающее значение для совещаний по согласованию архитектуры или технических обсуждений.
Функциональные требования в сравнении с техническими решениями В этой главе подчеркивается различие между функциональными требованиями (такими как получение пользовательских данных), которые обычно описываются в рамках API
Создание задачи и контекста При создании задачи важно помнить о конкретной цели задачи. Вы можете найти похожие задачи, если они не относятся к конкретному проекту. Также важно общаться с другими участниками задачи и согласовывать ее требования.
Концепция "Внутренней системы" "13" и "14" относятся к внутренним системным компонентам, которые доступны только внутри системы. API-интерфейсы должны быть описаны таким образом, чтобы их можно было использовать как внутри компании, так и за ее пределами.
Основные части: Названия методов и бизнес-требования Основные части включают названия методов, бизнес-требования, ограничения, функциональные описания на более высоком уровне на одной странице с использованием макросов для лучшей организации.
Страница контекстуальных методов и технических решений "Макрос страницы в облаке", который содержит подробные сведения о методах наряду со связанной информацией, такой как параметры или описания ошибок, помогает программистам более удобно понимать, как различные методы работают вместе.
Ссылки на страницы документации Когда вы связываете страницу с другой в документации, появляется ссылка. Есть два способа сделать это: один - с помощью привязок, а другой - путем указания конкретной задачи. Первый метод допускает выполнение аналитических задач и разочарование технического писателя, в то время как второй метод фокусируется на конкретных задачах.
Ограничивающие методы с неродной логикой "Неродная логика" относится к нестандартным или нетрадиционным решениям, которые нуждаются в объяснении. Предоставляя описания проблем и причин, стоящих за этими решениями, он помогает будущим разработчикам понять, почему был сделан определенный выбор.
Бизнес-требования Включение ссылок или подробных описаний бизнес-требований может быть полезно при работе в качестве бизнес-аналитика или оптимизации веб-страниц.
Понимание запроса В видео обсуждается, как можно отправить запрос на получение или выполнение определенных действий. Спикер подчеркивает важность использования человеческого языка и четкой коммуникации при определении запросов. Упоминаются различные типы запросов, такие как REST и прямые запросы к базе данных, а также их различия. Спикер также делится личным опытом разработки системы и столкновения с логическими ошибками.
Проверка разрешений профиля "Разрешения профиля" относятся к проверке того, имеет ли физическое лицо права на просмотр определенных профилей / учетных записей в системе. В этой главе подчеркивается необходимость проверки разрешений пользователя перед доступом к конфиденциальной информации, такой как данные профиля. Это предполагает взаимодействие с соответствующими командами или разработчиками, ответственными за управление этими разрешениями, а не дублирование усилий путем создания отдельных описаний.
Сбор данных и права учетной записи Система собирает данные на основе запросов пользователей, включая права учетной записи и информацию профиля. Это гарантирует, что запрошенная карта будет передана нужному человеку. Процесс бизнес-валидации включает в себя различные проверки, такие как проверка того, может ли человек получить доступ к профилю другого пользователя.
Системные действия и ответные меры "Бизнес-валидация" относится к любой проверке или верификации в системе с участием ее собственных заинтересованных сторон. Например, если пользователь не может просмотреть чужой профиль, не будучи зарегистрированным, в качестве обратной связи отправляется сообщение об ошибке или уведомление. Системные действия выполняются на основе этих проверок.
Обработка ошибок и статусов Ошибки во время проверки приводят к отображению пользователям сообщений об ошибках или уведомлений о технических неполадках. Если проверка не выполняется для определенного поля, такого как карточка профиля, это означает, что определенные поля необходимо временно оставить пустыми, пока они не станут актуальными.
Извлечение и обработка данных Извлечение данных из различных источников, таких как карточки профилей или вызовы API, имеет решающее значение для анализа. Используемый метод зависит от конкретных требований каждой области. Упорядочивая данные по столбцам и удаляя ненужную информацию, такую как данные пользователя, мы можем упростить процесс.
Поддержание точности документа "Получить карточку профиля" - это широко используемый метод, который извлекает конкретную информацию о профиле пользователя. Важно поддерживать этот документ в актуальном состоянии, регулярно обновляя его при внесении изменений в профили или добавляя новые поля с соответствующими сведениями, например, о том, кто внес изменения и когда.
Использование шаблонов в Confluence Создание шаблонов в Confluence позволяет эффективно создавать документацию, предоставляя предопределенные структуры, которые можно легко настроить в соответствии с индивидуальными потребностями.
Логика обработки таблицы Логика обработки таблицы предполагает формулирование заданного количества пунктов, до 20, которые могут быть организованы на разных уровнях. Однако по мере увеличения количества уровней сложность работы с ними также возрастает.
Иерархическая организация "Тематические контроллеры" позволяют осуществлять иерархическую организацию путем присвоения номеров категориям более высокого уровня, а затем подкатегориям под каждым контроллером. Хотя такой подход возможен, важно учитывать, что увеличение иерархии уровней усложняет понимание и навигацию.