How Mautic pairs Promptless with human review to catch up on docs

Описание и применение

Mautic использует Promptless для автоматического создания обновлений документации, которые затем проверяются разработчиками и командой обучения, ускоряя процесс с 98 до 27 дней и сокращая разрыв между кодом и документацией.

Задача

Documentation lagged behind code releases because volunteers had to manually write updates, causing outdated user and developer docs.

Результат

In four months Promptless produced 129 merged docs PRs, a 3.5× faster turnaround than manual updates, and closed a two‑version gap between code and docs.

Рабочий процесс

• 1. Developer opens a code PR in mautic/mautic.
• 2. Promptless monitors the PR and drafts a corresponding docs PR as a draft.
• 3. If the code PR is merged, Promptless marks the docs PR as ready for review.
• 4. Developers review the draft to ensure alignment with code changes.
• 5. The Education Team reviews grammar, style, and wording.
• 6. Once approved, the docs PR is merged.
• 7. Promptless learns from corrections to improve future drafts.

Доказательства

Docs updates made by Promptless took an average of 27 days from code merge to docs merge. Docs written by hand averaged 98 days.

Источник

Promptless once drafted a new section for an updated dropdown menu, but the improved labels already made the feature self‑explanatory, so the section would have only duplicated existing content.

Источник