Paras vastaus
Teknisiä asiakirjoja on niin monia tyyppejä, että on lähes mahdotonta luetella niitä kaikkia.
Pitkän teknisen kirjoittajaurani aikana minun on henkilökohtaisesti kirjoitettava yli 15 erilaista teknistä dokumenttia, jotka vaihtelevat projektista toiseen.
Abstraktimmalla tasolla tekniset asiakirjat voivat luokitella niihin, jotka on kirjoitettu sisäisille käyttäjille ja ulkoisille loppukäyttäjille .
Esimerkiksi järjestelmän määritysopas on esimerkki sisäisestä asiakirjasta, kun taas Asennusopas on esimerkki ulkoisesta loppukäyttäjäasiakirjasta.
-sovellusliittymäopas voi olla sekä sisäinen ja ulkoiset käyttäjät. Pikaopas puolestaan on melkein aina tarkoitettu ulkopuolisille loppukäyttäjille.
Olen kirjoittanut Käyttöoppaat , Vianetsintäoppaat , Viitearkit , Julkaisutiedot , (muokattu) Markkinointivaatimuksia koskevat asiakirjat (MRD), Arkkitehtuuri- ja tekniset asiakirjat (A&E Doc), Ohjetiedostot , Standard Operation Procedure (SOP) -oppaat ja paljon muuta.
Tervetuloa käymään teknisessä viestintäkeskuksessa saadaksesi lisätietoja ja ilmaista tietoa kaikista näistä erityyppisistä teknisistä asiakirjoista.
Vastaus
Olemassa olevia teknisiä asiakirjoja voidaan luokitella eri tavoin. En väitä tuntevani niitä kaikkia, mutta kaksi pääluokkaa, joita voit käyttää minkä tahansa teknisen dokumentaation luokittelussa, ovat käyttäjä ja käyttötapaus.
”Käyttäjä” tarkoittaa tarkoita mitä käyttäjän tyyppi käyttää asiakirjaa? Onko se järjestelmänvalvojan opas, opetusohjelma vai käyttöopas? Nämä tietotasot otetaan huomioon asiakirjaa suunniteltaessa. Järjestelmänvalvojan opas olettaa, että asiakirjaa lukeva henkilö tietää hieman enemmän kuin opetusohjelman lukija.
Tarkoitan ”käyttötapa”, mihin dokumenttia käytetään? Tämä voi vaihdella sotilasdokumentaatiosta ohjuksen laukaisemiseksi aina kehittäjän dokumentaatioon siitä, miten grafiikkasovellusliittymää voidaan käyttää videopelin kehittämiseen.
Jos pystyt kaventamaan kysymystäsi, voin ehkä pystyä antaa sinulle enemmän etsimäsi.