Развој воден од спецификации во Let Books

Блог Македонски

Како Let Books веќе користи спецификација, имплементациски насоки, документација, ограничувања на демото и правила за проверка како систем на развој воден од спецификации.


Let Books е корисен студиски пример за развој воден од спецификации бидејќи складиштето веќе содржи повеќе слоеви на продуктна намера, а не само имплементациски артефакти.

Проектот сè уште не е целосна хостирана апликација. Во моментов вклучува продуктна спецификација, имплементациски насоки, јавна документација и локално статично демо. Поради тоа е добар пример како проектот може да остане усогласен и пред да постои конечниот продукциски стек.

Слој на спецификација

AGENTS.md е јадрото на продуктната спецификација. Ги дефинира целта на проектот, доменот, тековите на работа, границите на обемот, насоката на локализација, приватноста, неопходноста на AI и критериумите за прифаќање.

Тоа е важно затоа што одговара на прашања на кои само кодот не може јасно да одговори:

  • зошто проектот постои
  • кои текови на работа се првокласни
  • што мора да работи без AI
  • што се идни идеи, а не сегашни обврски
  • што се смета за успешен прв демо-приказ

Тоа е разликата меѓу општ опис и вистинска спецификација. Вистинската спецификација ги ограничува имплементациските избори.

Слој на тактички насоки

AGENTS-Implementation.md го додава вториот слој. Не ја заменува продуктната спецификација, туку објаснува како моментално треба да се изведува работата во ова складиште.

Примери вклучуваат:

  • правила за јавно именување
  • правила за имплементација на документацијата
  • очекувања за метаподатоците на статичката страница
  • ограничувања на демото
  • очекувања за локализација и проверка
  • уредничка доказна политика за јавно пишување

Тоа е важно во работа поддржана со AI затоа што не секое правило припаѓа на долгорочната продуктна спецификација. Некои правила се тактички, уреднички или специфични за складиштето. Одржувањето на таа разлика јасна го намалува шумот и спречува продуктната спецификација да се претвори во складиште за имплементациски детали.

Слој на тековна состојба

README.md го претставува третиот слој: опис на тековната состојба.

Тој објаснува што постои денес, што сè уште не постои, за што служи статичното демо и како е објавена јавната страница. Тоа е клучен дел од усогласувањето, бидејќи проектите често потфрлаат кога читателите ја мешаат амбицијата со имплементацијата.

Во Let Books, README изречно прави разлика меѓу тековните испораки и идните планови. Тоа им помага на соработниците, институциите и рецензентите да ја разберат зрелоста на проектот без нагаѓање.

Слој на документација

Подрачјето docs/ го додава четвртиот слој. docs/README.md, docs/Development.md, docs/Deployment.md, водичите за стил и подрачјето sources одредуваат како знаењето треба да биде организирано, валидирано и објавено.

Тука складиштето станува повеќе од збирка датотеки. Станува платформа на знаење со:

  • архитектура на документација
  • правила за уреднички докази
  • повеќејазична издавачка структура
  • правила за објава на јавна документација
  • развојни и валидациски насоки

Тоа е токму видот рамка што помага испораката поддржана со AI да остане следлива.

Слој на демо

Статичното демо е важно, но намерно не е единствениот авторитет. Правилата за блогот и изворите веќе прават разлика меѓу канонска документација и статус на имплементација.

Тоа значи дека демото може да ги проверува тековите на работа, да открива проблеми со употребливоста и да помага при објаснување на надворешни чинители, без само од себе да стане конечна продуктна вистина.

Тоа е зрело правило. Без него прототипите често стануваат случајни механизми на управување. Тимот почнува да го копира прототипот затоа што постои, а не затоа што одразува одобрена продуктна одлука.

Слој на проверка

Let Books веќе документира и начин на размислување за проверка.

docs/Development.md и docs/Deployment.md опишуваат слоеви на валидација како:

  • smoke тестови за локализација
  • валидација на структурирани датотеки
  • генерирање метаподатоци
  • проверка на задолжителни датотеки
  • опционални правописни проверки и linting
  • автоматизација на објавување

Тоа не се само детали за алатките. Тоа е доказ дека проектот го третира квалитетот како повторлив систем.

Зошто ова е важно за AI-поддржана испорака

Ако AI помошник придонесува во Let Books, не мора да го измислува производот од почеток. Репозиториумот веќе содржи синџир на намера:

  1. продуктна насока во AGENTS.md
  2. тактички правила за испорака во AGENTS-Implementation.md
  3. тековна состојба во README.md
  4. правила за знаење и објава во docs/
  5. статус на извршлив прототип во статичното демо
  6. насоки за валидација и објава во развојната и имплементациската документација

Тој синџир не ги отстранува грешките. Но ги прави полесни за откривање и преглед.

Главна лекција

Развојот воден од спецификации не значи само да се напише долг документ со барања пред да започне кодирањето.

Во пракса, тоа значи да се изгради доверлив синџир меѓу:

  • продуктната намера
  • тактичките правила
  • јавната документација
  • демото
  • валидацијата
  • објавувањето

Let Books веќе покажува дека таков синџир може да постои и пред да постои целосниот backend производ.

Тоа е еден од најсилните аргументи за развој воден од спецификации во работа поддржана со AI: колку е појасен синџирот на намера, толку е помала веројатноста брзиот излез да се претвори во брза збунетост.