Kontrolní seznam pro předání aplikace
Kontrolní seznam pro předání aplikace shrnuje, co zkontrolovat při předávání hotové aplikace klientovi nebo nastupujícímu vývojovému týmu.
Shrnutí a kontext
Aplikace je hotová a předáváte ji klientovi? Gratuluji! Zbývá sesumírovat všechny informace nasbírané během vývoje a doručit je v přehledné formě. Tento kontrolní seznam slouží jako vodítko pro běžný proces předání aplikace.
1. Repozitář zdrojového kódu a převod vlastnictví
Než je projekt označen za „předaný“, musí být veškerý zdrojový kód uložen v repozitáři vlastněném nebo spravovaném klientem.
Pokud je projekt hostován na privátním účtu vývojáře, převeďte vlastnictví na klienta anebo zajistěte, aby klient měl plná práva k repozitáři.
Commitnutí souboru .env nebo privátních API klíčů patří mezi nejčastější příčiny bezpečnostních incidentů při předávání.
2. Hosting, doména a infrastruktura
Převeďte vlastnictví produkčního hostingového účtu na klientův fakturační účet.
Zkontrolujte DNS záznamy domény, hostingový účet, zálohování a obnovu SSL certifikátů, že jsou správně nastavené a funkční.
3. Účty a služby třetích stran
Pokud aplikace odesílá e-maily, má integrovanou platební bránu, webové analytiky, přihlašování přes třetí strany a další externí API a služby, pak každá z těchto služeb má svůj účet a vlastníka.
Sepište všechny služby, na kterých aplikace závisí, a u každé uveďte, kdo je vlastníkem účtu, kdo službu platí a jestli se účet převádí na klienta nebo si klient zakládá vlastní.
4. CI/CD pipeline a proměnné prostředí
Automatizované nasazení odstraňuje lidskou chybu z procesu předání. Zdokumentujte každý secret, který deployment pipeline potřebuje. Pokud má klient specifická hostovací prostředí nebo bezpečnostní protokoly, zdokumentujte je.
name: Production deploy
on:
push:
tags:
- 'v*'
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Deploy to production
run: npm run build && npm run deploy
env:
DATABASE_URL: ${{ secrets.PRODUCTION_DATABASE_URL }}5. Dokumentace
Dokumentace není jen uživatelská příručka k aplikaci. Během vývoje aplikace se kompletuje spousta informací, které se postupně uchovávají v různých dokumentech a dokumentačních službách.
Nemusíte všechno přepisovat do jednoho dokumentu. Stačí, když klient budete vědět, kde jednotlivé dokumentace najde. Co všechno o aplikaci evidovat, popisuje článek Co dokumentovat v softwarovém projektu. Jako rozcestník pro klienta poslouží šablona dokumentace softwaru.
6. Testy a kvalita
Pokud má zákazník k dispozici testovací prostředí, měl by vědět, jak ho používat a jak ověřit funkčnost aplikace.
7. Bezpečnost, licence a osobní údaje
Klient přebírá i odpovědnost za to, co aplikace obsahuje a jaká data zpracovává. Potřebuje proto vědět, jaké knihovny třetích stran aplikace používá, pod jakými licencemi a kde ukládá osobní údaje.
8. Stav aplikace při předání
Předávací protokol musí jednoznačně říct, co přesně se předává. Nejspolehlivější je to vyjádřit číslem verze a tagem v repozitáři, ke kterým patří seznam změn a známých problémů. U technického dluhu ohodnoťte složitost každé položky, aby se mohlo naplánovat jeho řešení.
9. Předání znalostí a podpora po předání
Domluvte si společnou schůzku pro předání znalostí, projděte aplikaci i předávací protokol a vysvětlete si všechny nejasnosti.
Vysvětlete si také, co se bude dít po předání aplikace: jak dlouho trvá záruka, kdo řeší chyby a kam je hlásit. Pokud aplikaci dál udržujete, sepište s klientem i plán údržby. Doby reakce na chyby zachyťte v SLA.
10. Doplňte odkazy k vaší aplikaci v AboutTheApp
Místo psaní předávacího dokumentu, vložte přímo k aplikaci odkazy na repozitáře, CI/CD pipeline, administraci domény a další služby.
Klient nebo budoucí správce díky tomu bude mít okamžitý přístup ke všem službám přímo z aplikace, kterou používá nebo spravuje.
Přidání widgetu AboutTheApp do všech projektů dá každému předání stejnou předvídatelnou podobu, což později snižuje počet dotazů typu „kde najdu“. Vždy to bude mít stejné místo a stejnou formu.
| Informace | Veřejný pohled | Soukromý (odemčený) pohled |
|---|---|---|
| Verze aplikace a datum vydání | Viditelné pro kohokoli | Stejné, navíc s celou historií |
| Autor a licence | Viditelné | Stejné, navíc kontakt na agenturu |
| Odkazy na repozitář a návrhy | Skryté | Viditelné s odemykacím kódem nebo dle role |
| Stav nasazení a prostředí | Skryté | Viditelné s odemykacím kódem nebo dle role |
11. Předávací protokol a akceptace
Předání uzavírá předávací protokol podepsaný oběma stranami. Shrnuje, co se předalo, v jaké verzi a s jakými známými omezeními, a určuje datum, od kterého provoz přebírá klient. Šablonu ke zkopírování najdete v článku Šablona předávacího protokolu.
Časté otázky
Co má obsahovat předávací protokol softwaru?
Seznam předávaných částí (přístupy, odkazy na repozitáře, dokumentaci, hostingové účty, zálohy atd.), stav aplikace v okamžiku předání včetně verze, známé chyby a omezení, kontakty a datum předání. Protokol podepisují obě strany.
Komu patří zdrojový kód po předání aplikace?
Určuje to smlouva o dílo nebo licenční ujednání, ne samotné předání. Ještě před začátkem projektu si ve smlouvě vyjasněte, zda klient získává výhradní práva ke kódu nebo jen licenci k užívání. Během vývoje aplikace si ověřujte licence použitých knihoven a komponent třetích stran.
Jak bezpečně předat hesla a přístupy?
Nikdy ne e-mailem ani v chatu. Použijte sdílení ve správci hesel nebo převeďte účty přímo na klienta. Po předání nechte klienta změnit hesla a vygenerovat nové API klíče, aby k produkci neměl přístup nikdo, kdo už na projektu nepracuje.
Co předat, když aplikaci přebírá jiný vývojář, ne klient?
Kromě přístupů a infrastruktury je vhodné předat také návod na spuštění projektu lokálně, interní popis architektury a důležitých rozhodnutí, seznam známých chyb a technického dluhu a postup nasazení. Ideálně s krátkým společným průchodem kódu.
Kam sbírat informace o aplikaci, aby se neztratily?
Na jednom místě, které je spojené přímo s aplikací a které klient i další vývojáři rychle najdou. V AboutTheApp k aplikaci připojíte odkazy na repozitáře, dokumentace a další externí služby. Soukromé odkazy uvidí jen ten, kdo k nim má přístup, veřejné odkazy jsou dostupné všem.
Ve zkratce
Sbírat všechny informace v průběhu vývoje aplikace do jednoho místa a vložit je přímo do aplikace je nejjednodušší způsob, jak si zjednodušit předání celého projektu klientovi.
Chcete si předávání zjednodušit?
Přidejte si zdarma vaši aplikaci do AboutTheApp.