Få armene rundt et teknisk dokument

June 23  by Eliza

Hensikten med å skrive et teknisk dokument er å forklare eller rapportere om en teknisk eller komplekst tema. Derfor, med mindre du er den tekniske guru skrive om noe du vet nært, må du forskning emnet. Samle inn data - å lære alt du kan om produktet eller tjenesten - er selve livsnerven i prosjektet.

Intern forskning

Hvis forskningen er interne, samle inn informasjon ved å intervjue SMB (fageksperter) og andre som er involvert i prosjektet, observere mennesker i og rundt arbeidsplassen, lesing spec ark og selskapet litteratur, og bare snusing rundt. Her er noen tips for å holde nesen til slipestein uten å få den kuttet:

  • Bli kjent med produktet eller tjenesten nært.

• Test det. Bruke den. Klem det. Lær alt du kan.

• Study system specs og tekniske tegninger.

• Intervju SMB. Ta med en liste over spørsmål du forberedt.

  • Absorbere det store bildet.

• Finn ut om formålet med råvarer eller tjenesten, som skal bruke det, hvorfor og når.

• Lær akronymer.

• Bli kjent med gode og dårlige egenskaper ved produktet eller tjenesten.

• Lær om eventuelle feil med produktet, for eksempel hvilke funksjoner som kan brekke, funksjonssvikt eller forårsake problemer.

  • Koselig opp til markedsføring og salg avdelinger.

• Lær fordeler og ulemper ved produktet eller tjenesten.

• Forstå funksjonene og fordelene du trenger å markere.

• Vite hvordan den manuelle vil bli distribuert og oppdatert.

• Finn ut om det finnes relaterte publikasjoner eller manualer.

  • Finn ut om du trenger å forberede utpakking instruksjoner eller en delelister.

• Spør hva som er i emballasjen.

• Spør om brukeren trenger instruksjoner for å installere eller montere elementet.

  • Samle så mye skrevet eller grafiske data som du kan. Du kan alltid kaste det du ikke trenger.

• Bestem hva bilder eller grafikk du trenger.

• Få kopier av en stil manuell eller standard tekst som lignende prosjekter brukt.

Det er viktig at du ikke bare stole på hukommelsen. Ta innholdsrik notater mens du gjør din forskning.

Ekstern forskning

Du gjør ekstern forskning ved å intervjue folk utenfor organisasjonen, besøke biblioteket, eller surfer på nettet. Her er noen råd for å gjøre jobben din enklere:

  • Intervju folk utenfor din bedrift. Du kan enten besøke folk personlig eller sende et spørreskjema. Der å gjøre, selvfølgelig, avhenger av arten av din forskning. Hvis du trenger å samle informasjon fra mange mennesker, kan du finne et spørreskjema er hensiktsmessig. Hvis du trenger å møtes ansikt til ansikt med en eller flere personer, følge disse retningslinjene:

• Utarbeide en liste over mål og spørsmål på forhånd.

• La intervjuobjektet gjør det meste av snakkingen. Tross alt, du er der for å lære.

• Grab all litteratur intervjuobjektet er villig til å dele.

• Ta innholdsrik notater eller bruke en båndopptaker, dersom det er hensiktsmessig.

  • Gjøre forskning på biblioteket. Det finnes en rekke måter å bruke biblioteket for forskning. Hvis du trenger hjelp med noen av følgende bibliotektjenester, spør bibliotekaren:

Kortkatalog: Kort kataloger er alfabetisk ordnet etter forfatter, tittel og emne til å reflektere alle bøker og ressurser biblioteket eier.

Bibliografier og periodiske indekser: Bibliografier liste tidsskrifter, bøker og annet publisert forskning i et bredt spekter av fagområder. Periodiske indekser liste magasiner, tidsskrifter og avisartikler. Biblioteker noen ganger huset bibliografier og tidsskrifter i et eget rom. Nyere indekser kan være på sokkelen, mens eldre indekser kan være i en annen del av biblioteket eller i mikroformer.

Oppslagsverk: Disse inkluderer leksika, ordbøker, håndbøker, manualer, statistiske kilder, atlas, og mer.

  • Surfe på nettet. Hvis du ikke kjenner nettadressen til nettstedet du vil, få tilgang til en av de mest populære søkemotorer. Følgende er noen høydepunkter:

Skriv inn et søkeord eller en setning. Søkemotoren ser for dokumenter som har søkeordet (e). Den rangerer deretter nettsteder basert på hvor mange ganger søkeordet ditt vises i dokumentet, om søkeordet vises i tittelen, hvor tidlig søkeordet vises i teksten, og så videre.

Prøv å gjøre søket så smal som mulig. Ellers kan du få tusenvis av treff. For eksempel, hvis du søker etter hunden, får du nettsteder for flere hunder enn du ønsker å bjeffe på deg. Hvis du søker på puddel, du får alle typer pudler. Hvis du søker etter leketøy puddel, begrense deg søket til leken variasjon bare.