Přeskočit obsah

Nástroje

Žádná doporučení. Žádné affiliate odkazy. To jsou nástroje, které skutečně používám, důvody, proč jsem je vybral, a upřímná upozornění.

Psaní a správa znalostí

Obsidian — veškerá dokumentace začíná tady. Čisté markdown soubory, lokální úložiště, žádná závislost na cloudu. Celý dokumentační stack libdrone žije v Obsidian vaultu předtím, než je zveřejněn kdekoliv. Používám ho na osobní zápisky, projektovou dokumentaci a vše, co chci být schopen číst za deset let bez ohledu na to, co se stane s jakoukoli firmou.

Proč ne Notion, Confluence apod. — v práci používám Confluence a na to, co dělá, je v pořádku. Pro nic, co vlastním, bych ho nepoužil. Markdown ve složce je formát. Confluence je produkt. Když se produkt změní nebo zmizí, formát zůstane.

Publikování dokumentace

MkDocs s Material tématem — generátor statických stránek z markdownu. Tento web na něm běží. libdrone.eu na něm běží. Rychlý, spolehlivý, verzovaný. mkdocs build produkuje složku HTML. Nginx ji servíruje.

Proč ne Hugo, Jekyll apod. — zkoušel jsem jiné. Material for MkDocs má nejlepší sadu funkcí zaměřenou na dokumentaci a lze ho konfigurovat bez boje. Pro technickou dokumentaci konkrétně je to správný nástroj.

Design hardware

CadQuery — parametrické CAD v Pythonu. Generátor rámu libdrone je 1 815 řádků Pythonu, který produkuje všechny tištěné díly z jednoho souboru proměnných. Učím se to. Je to těžké. Stojí to za to, protože výstup je reprodukovatelný a verzovaný způsobem, jakým proprietární CAD soubory nejsou.

FreeCAD — pro práci, která nepotřebuje plnou parametrickou generaci. Open source, rychle se zlepšuje. FreeCAD Cookbook v dokumentaci libdrone pokrývá celý workflow.

Onshape — prohlížečové CAD, užitečné pro rychlé reference a spolupráci. Není můj primární nástroj.

3D tisk

PRUSA CoreOne — postaven ze soupravy. Proces sestavení je sám o sobě dokumentačním cvičením — PRUSA manuál je jeden z nejlepších kusů technické dokumentace v prostoru spotřebitelského hardware. Učil jsem se z něj.

AI

Claude (Anthropic) — primární AI nástroj pro dokumentační práci. API používám pro dokumentační pipeline libdrone. Webové rozhraní pro přemýšlení o architektuře a psaní návrhů. Důvod, proč jsem ho vybral před alternativami, je kvalita uvažování u složitých technických témat a schopnost udržet kontext přes dlouhé dokumenty.

Infrastruktura

Synology NAS — hostuje všechny weby včetně tohoto. Nginx servíruje statické soubory. Jednoduché, spolehlivé, běží doma, pod mou kontrolou.

Git — vše je verzováno. Dokumentační stack, CadQuery generátor, konfigurace webů. Pokud se něco rozbije, mám historii.