Odkazy projektu: jak je mít všechny na jednom místě
Odkazy v projektu je dobré mít pohromadě na jednom místě, ať už jsou interní nebo určeny pro zákazníka. AboutTheApp je přímo stavěné pro sdílení odkazů.
Shrnutí a kontext
Všechny odkazy projektu uložíte přímo k vaší aplikaci. Repozitář, dokumentaci, hosting, monitoring i podporu tak máte pohromadě v jednom seznamu a u každého odkazu určíte jeho viditelnost. Zákazník nebo konkrétní prostředí může mít vlastní odkazy. Tým je najde v dashboardu a na stránce o aplikaci, uživatel přímo v běžící aplikaci.
1. Proč na odkazy projektu nestačí sdílené záložky ani wiki
I když se často používají sdílené záložky, vyhrazené dokumenty nebo stránky ve wiki, nevýhodu mají v tom, že přístup k nim není jednotný a udržují se odděleně od samotné aplikace. Běžná synchronizace záložek v prohlížeči je navíc vázaná na účet a spravované záložky v Chromu nastavuje správce pro celou firmu, ne pro jednotlivý projekt. Podpora, zákazník nebo nový kolega pak odkaz nenajde a musí se doptávat.
Skutečný projekt navíc potřebuje víc než seznam adres. Část odkazů smí vidět kdokoli, část jen tým a další jsou platné pro konkrétního zákazníka nebo jeho prostředí. Zůstává i otázka, jak se k odkazům dostat z aplikace, kterou zrovna používáte. Tohle sdílené záložky ani wiki neřeší. Proto AboutTheApp drží odkazy přímo u aplikace.
2. Které odkazy k aplikaci patří
K aplikaci patří všechno, co člověk potřebuje k práci s aplikací, ať už má jakoukoliv roli. AboutTheApp na to má 13 kategorií, viz tabulka níže. Poslední sloupec v tabulce je obvyklé nastavení, u každého odkazu si ho určíte sami.
| Kategorie | Příklady odkazů | Obvykle vidí |
|---|---|---|
| Zdrojový kód a architektura | Repozitář, diagramy architektury | Tým |
| Dokumentace | Uživatelská příručka, technická dokumentace, wiki | Příručku všichni, zbytek tým |
| API | Dokumentace API, kolekce požadavků | Podle toho, jestli je API veřejné |
| DevOps a infrastruktura | CI/CD pipeline, hosting, DNS | Tým |
| Monitoring a kvalita | Monitoring, logy, výsledky testů | Tým |
| Bezpečnost | Položka ve správci hesel, bezpečnostní audit | Tým |
| Sledování úkolů | Nástěnka úkolů, backlog | Tým |
| Analýza a plánování | Zadání, plán vývoje | Tým |
| Grafické návrhy | Návrhy ve Figmě | Tým |
| AI a Vibecoding | Projekt v nástroji na tvorbu aplikací, dokument s prompty | Tým |
| Podpora | Helpdesk, e-mail podpory, stránka se stavem služby | Všichni |
| Právo a vztahy | Podmínky použití, zásady ochrany osobních údajů, smlouva | Zásady všichni, smlouvu zákazník |
| Obchod a CRM | Ceník, záznam v CRM | Ceník všichni, CRM tým |
3. Jak přidat odkazy k aplikaci
Odkazy přidáte v editoru produktu v AboutTheApp přímo k dané aplikaci. Stačí je jednou přenést ze záložek, README, wiki nebo z vaší paměti.
- 1
Založte aplikaci
V dashboardu klikněte na Přidat produkt a vyplňte název a alias. Alias určuje jedinečnou adresu v About page, například rezervace-zasedacek bude mít adresu aboutthe.app/rezervace-zasedacek. Pokud je váš produkt jedinečný, použijte název produktu, jinak zvolte kombinaci s názvem firmy, týmu nebo projektu.
- 2
Přidejte odkazy
V části Odkazy klikněte na Přidat odkaz, vyberte kategorii a vyplňte adresu nebo e-mail. Volitelně doplňte vlastní popisek a krátký popis.
- 3
Určete viditelnost
U každého odkazu zvolte, zda-li je Veřejný nebo Soukromý.
- 4
Seřaďte odkazy
Na úrovni Produktu (globální) změníte pořadí odkazů jejich přetažením pomocí myši.
4. Veřejné a soukromé odkazy
Veřejné odkazy vidí každý návštěvník About page i uživatel About boxu ve vaší aplikaci. Soukromé odkazy vidí přihlášení členové vašeho týmu a ten, kdo zná kód pro odemknutí. Návštěvník bez kódu je nevidí vůbec, případně je může vidět jako zamčené, bez adresy, pokud v panelu integrace zapnete volbu Zobrazit i soukromé odkazy (jako zamčené).
Kód pro odemknutí necháte vygenerovat nebo zadáte vlastní a nastavíte ho pro celou aplikaci, pro jednoho zákazníka nebo jen pro jedno jeho prostředí. Každý kód odemkne jen svůj rozsah, takže zákazník s vlastním kódem neuvidí soukromé odkazy celé aplikace. Kód se předává v adrese About page jako unlockCode nebo atributem unlock-code u About boxu.
Kód pro odemknutí nevyprší a není vázaný na uživatele. Slouží k tomu, aby interní odkazy neviděli návštěvníci, kterým nejsou určené, ne k ochraně tajemství. Hesla a API klíče do AboutTheApp nepatří, umístěte je do správce hesel a k produktu se uložte jen odkaz na ně.
5. Odkazy pro jednotlivé zákazníky a prostředí
Odkazy v AboutTheApp mají tři úrovně, které se hierarchicky skládají. Přepínačem v editoru produktu vyberete, pro koho odkaz platí. Pokud má zákazník více prostředí, můžete zvolit i konkrétní prostředí.
Zákazník dědí odkazy z úrovně produktu. Jakmile ale má v některé kategorii vlastní odkaz, nahradí na jeho stránce všechny odkazy této kategorie z vyšší úrovně. Stejně tak odkaz prostředí nahradí odkazy téže kategorie u zákazníka. Zděděný odkaz upravíte tlačítkem Odpojit, které z něj vytvoří upravitelnou kopii, a tlačítkem Vrátit na nadřazenou úroveň se vrátíte k původnímu. Pokud chcete v kategorii nechat zděděné odkazy spolu s vlastním, odpojte je všechny.
Zákazník svoje odkazy uvidí na adrese aboutthe.app/alias-aplikace?customerAlias=alias-zakaznika, případně s parametrem environment pro jedno prostředí. Tyto stránky se neindexují ve vyhledávačích. Můžete tak mít jednu aplikaci u více klientů a každý klient vidí svůj helpdesk, svou dokumentaci a svá prostředí.
| Úroveň | Pro koho platí | Příklad |
|---|---|---|
| Produkt (globální) | Všechny zákazníky a návštěvníky | Uživatelská příručka, zásady ochrany osobních údajů, repozitář |
| Zákazník | Jednoho zákazníka, všechna jeho prostředí | Helpdesk klienta, smlouva, dokumentace na míru |
| Prostředí zákazníka | Jedno prostředí zákazníka | Administrace stagingu, testovací účty, monitoring produkce |
6. Kde odkazy uvidí tým, zákazník a uživatel
Odkazy z AboutTheApp jsou dostupné na třech místech a všude jsou stejné. About page na adrese aboutthe.app/alias-aplikace je hostovaná stránka, kterou můžete poslat komukoli. About box můžete vložit přímo do aplikace jako webovou komponentu, takže se uživatel i podpora dostanou k odkazům přímo z běžící aplikace. Můžete si vytvořit i vlastní zobrazení pomocí jednoduchého API GET /abouts/:alias.
Změna odkazu v dashboardu se projeví bez nového nasazení aplikace. Když se dokumentace přesune jinam, opravíte ji na jednom místě. README a wiki pak nemusí držet vlastní kopii seznamu, stačí v nich odkaz na About page. Do README můžete vložit i odznak z panelu Integrovat (aboutthe.app/badge/alias-aplikace), který ukazuje název a aktuální veřejnou verzi aplikace a vede na About page. Na dashboardu navíc vidíte všechny aplikace pohromadě, což se hodí jako základ evidence aplikací, a odkaz na About page usnadní i předání aplikace.
7. Jak udržet odkazy aktuální
Odkazy zůstanou aktuální, když je pravidelně používáte nebo při jejich změnách. Nové prostředí, nová služba nebo změna nástroje znamená i úpravu odkazu v AboutTheApp.
Odkazy se přidávají ručně, záložky z prohlížeče se neimportují. Confluence, Jira i GitHub zůstávají tam, kde jsou, AboutTheApp na ně jen odkazuje.
Časté otázky
Jak mít všechny odkazy projektu na jednom místě?
Uložte je přímo k aplikaci v AboutTheApp. Odkazy jsou rozdělené do kategorií, u každého určíte, jestli je veřejný nebo soukromý, a tým, zákazník i uživatel je najdou na About page nebo v About boxu v aplikaci.
Stačí na odkazy projektu sdílené záložky?
Malému týmu vývojářů na začátek ano. Záložky ale nerozliší veřejné a interní odkazy ani odkazy pro jednotlivé zákazníky a podpora ani zákazník se k nim nedostanou. Běžná synchronizace záložek navíc platí jen pro jeden účet, takže sdílení vyžaduje rozšíření prohlížeče nebo správce v konzoli Google Admin.
Jak ukázat zákazníkovi jen jeho odkazy?
Přiřaďte zákazníka k aplikaci a přidejte mu odkazy na úrovni Zákazník nebo jednoho jeho prostředí. Pošlete mu adresu About page s parametrem customerAlias. Pro soukromé odkazy mu můžete nastavit vlastní kód pro odemknutí, který odemkne jen jeho rozsah.
Můžu do AboutTheApp uložit hesla a API klíče?
Ne. AboutTheApp není trezor a soukromé odkazy chrání jen kód pro odemknutí, který nevyprší. Uveďte jen odkaz na položku ve správci hesel nebo v trezoru tajných klíčů a přístup řiďte tam.
Jsou odkazy pro zákazníky a soukromé odkazy zdarma?
Ano, veřejné a soukromé odkazy i odkazy pro zákazníky a prostředí jsou na všech tarifech. Tarif Free je omezený na jednu aplikaci a jednoho člena, členy týmu lze zvát na tarifu Team.
Ve zkratce
Odkazy projektu patří k aplikaci, ne do záložek jednotlivých uživatelů. V AboutTheApp je přidáte jednou, určíte, kdo je uvidí, a tým, zákazník i uživatel je najdou na stejném místě.
Chcete mít odkazy přímo u aplikace?
Založte si zdarma účet v AboutTheApp a přidejte ke své aplikaci odkazy na kód, dokumentaci, hosting a podporu.