За кого се пише
За човек, който трябва да пусне и разбере системата ви, без да може да ви пита. Това е и критерият: ако съученик от друг клас може да я стартира по вашия текст, документацията е добра.
Съдържание
| Раздел | Какво съдържа |
|---|---|
| Задача | какъв проблем решава и за кого, в едно изречение |
| Данни | източник, обем, лични данни и основание, дневник на почистването |
| Архитектура | диаграма, слоеве, външни зависимости |
| База | ER диаграма и скрипт за създаване от нулата |
| AI функция | промпт (или препратка към файла), модел и версия, настройки |
| Измерване | набор от заявки, мерки, таблица преди/след, обяснение |
| Сигурност | списъкът за проверка от урок 26 с отговори |
| Етика | четирите въпроса: данни, риск, обозначаване, грешки |
| Ограничения | какво системата не може и къде не бива да се ползва |
| Стартиране | стъпки от нулата: зависимости, ключ, база, пускане |
Двата най-често пропускани раздела
„Ограничения“ и „Стартиране“. Първият показва зрялост, вторият — дали проектът изобщо е използваем от друг човек.
Разделът за данните
- Откъде идват данните и кой ги е предоставил.
- Реални, обезличени или синтетични — и защо.
- Обем: брой документи, парчета, записи.
- Какво е изхвърлено при почистването и колко.
- Какви лични данни има, на какво основание, кога се трият.
Ако сте работили със синтетични данни, запишете как са построени и кои изводи не могат да се пренесат върху реални хора. Това е сила, не слабост.
Стартиране от нулата
## Стартиране
1. Изисквания: Python 3.12, PostgreSQL 16 с разширение pgvector
2. pip install -r requirements.txt
3. Създайте базата:
psql -f data/shema.sql
python data/zaredi.py
4. Задайте ключ:
export MODEL_API_KEY=... (Windows: setx)
5. Пуснете:
uvicorn src.web:app --reload
6. Отворете http://localhost:8000Проверете стъпките на чужда машина
Почти всяка документация пропуска една стъпка, която авторът е направил преди месец и е забравил. Единственият начин да се открие е да я изпълни друг човек.
Подготовка на защитата
Времето
Десет минути: задача (1), демонстрация (3), архитектура и решения (2), числа (2), ограничения (1), въпроси (1).
Материалите
- Приложението, тръгващо от чист старт.
- Видео за резерва, локално.
- Таблицата с числата преди и след.
- Пет подготвени въпроса, единият от които се проваля.
- Разпечатана или отворена диаграма на архитектурата.