Как документировать переменные окружения без секретов.
Документируйте имена, назначение и значения по умолчанию без раскрытия реальных секретов. Указывайте обязательность переменной и место её чтения.
Адаптируйте процесс под свою задачу.
Составьте перечень переменных и мест их чтения, записывая назначение, обязательность и безопасные примеры. Отличайте явное значение по умолчанию от допущения и исключайте реальные секреты из документации.
- Что вы предоставляете
- Имена настроек без чувствительных данных и ожидаемое поведение.
- Что вы получите
- Справочник конфигурации без секретных значений.
Посмотрите входные данные и результат.
Иллюстративные входные и выходные данные · учебный пример, а не реальный запуск WebAct
Полей ввода: Пример
Document APP_PORT (listening port) and SMTP_PASSWORD (mail service credential). Defaults, requiredness and code locations have not been supplied.
Готовый пример
APP_PORT Purpose: port on which the application listens. Example: 3000 (illustrative, not a confirmed default). Default / required / code location: confirm from the application. SMTP_PASSWORD Purpose: credential for the configured mail service. Example value: <set-through-secret-configuration>. Default / required / code location: confirm from the mail integration. Keep the real credential out of shared examples and version control.
Добавьте эти данные в промпт и скопируйте его в WebAct, чтобы попробовать задачу. Ваш результат может отличаться от примера.
Решения и устранение проблем.
Должна ли документация секретных настроек содержать рабочие учётные данные?
Используйте заполнитель и объясните утверждённый способ передачи. Документация должна обозначать требование без раскрытия секрета.
Почему руководство описывает значение по умолчанию, которое приложение не использует?
Проследите переменную до места чтения или предоставленной конфигурации. Отмечайте неизвестное поведение, а не угадывайте по имени.
Попробуйте на собственном источнике.
Замените пример своим материалом в промпте. Сохраните нужные требования и скопируйте задачу в WebAct.
Настроить и скопировать задачу ↑