Jak načrtnout technické dokumenty pro psaní. Dobře napsaný dokument není vytvořen náhodou. Materiál obsažený ve zprávě, manuálu nebo jiném technickém dokumentu je plánován, organizován a následně napsán. Konstrukční fáze dokumentu je klíčovým krokem a pravděpodobnost, že informace nebudou představovány logicky, pokud nebude vytvořen obrys. Vykreslení dává autorovi možnost přemýšlet o informacích, které by měly a neměly být zahrnuty.
Brainstorm své nápady. Zapište si nějaké nápady do vašeho obrysu, které si myslíte, že by měly být zahrnuty do technického dokumentu. Nesnažte se poradit s informacemi. Je jen důležité, že všechny informace jsou zahrnuty do procesu brainstormingu.
Určete účel technického dokumentu. Zeptejte se sami sebe na otázky, jako kdo čte dokument, proč to bude číst a jak bude použit.
Rozhodněte, jaký typ obrysu byste chtěli vytvořit: historický, chronologický, specifický pro obecný, malý až velký, jednoduchý až složitý nebo jakoukoli jinou formu vhodnou pro obsah. Přemýšlejte o publiku ao informacích, které chcete prezentovat. Ujistěte se, že způsob, jakým jsou informace uspořádány, má největší smysl pro typ informací, které jsou prezentovány, a pro publikum, které bude číst technický dokument.
Uspořádejte informace v příslušném pořadí. Obrys zahrnuje seskupení informací do logických úseků a úrovní. Můžete vytvářet hlavní témata, podkategorie a podkapitoly.
Dokončení náčrtu přezkoumáním informací k ověření, zda jsou předměty organizovány vhodně a logicky. Ujistěte se, že vám chybí žádné klíčové skutečnosti. Smazat veškeré informace, které nejsou pro technický dokument relevantní.
