To go places and do things that have never been done before – that’s what living is all about.

Författarens förord

Föreliggande publikation är ett "proof of concept".

Målformatet för denna publikationen är den tryckta boken, i stående A5-format. Tryckningen genomförs via skapandet av en (eller flera) PDF-fil(er) och digitaltryckning enligt konceptet för "Print On Demand".

Någon sofistikerad programvara för layout så som FrameMaker, InDesign eller MSWord har inte används, utan underlaget för den tryckta boken är ett alternativt presentationsformat, som tagits fram parallellt med framtagningen av en hemsida (Se: Demo.) samt en wiki. Wiki:n används även vid projektledning, administration och editering av den kunskapsbas där framtagna bilder och texter lagras.

Denna utvecklingsprocess har fördelar och nackdelar. Den största fördelen är att alla ändringar sker samtidigt både på hemsidan och i underlaget för den tryckta publikationen. Vid en vidareutveckling av detta koncept kan användaren själv ändra (alternativt lämna ändringsförslag) och själv skriva ut publikationen, på en lokal skrivare. Detta leder till en, näst intill, oslagbar smidighet i arbetet med att dokumentera tekniska produkter samt vid framtagning av Manualer och Instruktionsmaterial.

Inledning

Söker vi på internet, efter information om publiceringssystem för teknikinformation, kommer vi i kontakt med en mängd begrepp, vars betydelse inte är helt självklara, eller entydiga.

En grundläggande kännedom om de viktigaste begreppen hjälper oss att bättre förstå fördelar och nackdelar med de tekniska lösningar som står oss tillbuds, när vi vill publicera dokument, så som Manualer, Bruksanvisningar, Guider och Undervisningsmaterial för tekniska produkter. Målgruppen för dessa dokument kan vara så väl specifika yrkesgrupper som slutanvändare eller konsumenter.

Vi kommer här att presentera ett antal användarscenarier med en översiktlig förklaring av grundläggande begrepp.

Denna publikation är framtagen med hjälp av TiddlyWiki som är "en personlig anteckningsbok, i wiki-format". TiddlyWiki har utvecklats av Jeremy Ruston. Applikationen har anpassats till att bli ett verktyg för självpublicering, av författaren.

Publikationen är ett 'proof of concept'. Det vill säga, denna publikationen visar att vi enkelt kan utveckla verktyg för framtagning av tekniska publikationer, med hjälp av standardlösningar för internet.

Därmed väcks frågor:

Håller Teknikinformatörens arbete på att integreras med andra yrkesgrupper, så som applikationsutvecklare- och webbutvecklare, på samma sätt som sekreterarrollen har integreras i en mängd olika yrkesroller?

Samtidigt betonar denna publikation behovet av ett systemtänkande, vilket säkerställer att

rätt information finns tillgänglig,
för rätt användare,
vid rätt tillfälle.
Är detta Teknikinformatörens framtida arbetsområde?

Info

Texten i befintlig publikation riktar sig till nybörjare.

Det finns böcker och mer djupgående information på internet.

I slutet av publikationen finns referenser och läsanvisningar.

ON-line eller OFF-line

När detta publiceras (2016) finns det en ständigt återkommande diskussion om man bör lagra (arkivera) sina dokument (data) lokalt eller i "molnet".

Molnet är ett annat namn för "via internet".

I Molnet är det ofta okänt på vilken fysisk enhet som data lagras vilket göra att tekniken kan upplevas som luddig, likt ett moln. Därav namnet.

Fördelar med virtuella lagringsadresser är, att

servrar och andra fysiska enheterna kan bytas ut, utan att användaren påverkas. Detta ger en flexibel lösning, vilken kan anpassas efter aktuella behov.
backup och uppdatering av programvara kan skötas centralt, utan att användaren behöver göra något aktivt.

Nackdelar är, att

säkerheten kan vara svår att överblicka, då det gäller övervakning på nätet - även om man använder senaste säkerhetstekniken. NAS:s intrång var inte något misstag. Notera att även om data är krypterad kan all trafik på nätet övervakas och kommunikationsvägar loggas tillsammans med användarnas IP-adresser.
användaren har inte full kontroll över program- eller systemuppdateringar.

Generellt är rådet, att om man har möjligheter och nödvändiga resurser samt rätt kompetens bör man lagra kritisk data lokalt för att själv ha kontroll över backup:er och mjukvaruuppdateringar, medan okänsliga dokument med fördel kan lagras på nätet.

Molnlösningar är ofta ett säkert, billigt och tillförlitligt alternativ, för den som inte vill avsätta tid och resurser för en lokal lösning. Många har inte resurser och den kompetens som krävs för att själv göra en lokal lösning, med samma prestanda och kvalitet.

Vid val av lösning bör man dock säkerställa att man inte blir beroende av tjänsteleverantören, utan att man när man vill - med enkelhet - kan flytta all data till en annan lagringstjänst.

Bakom scenen

Användarscenario 1

År 2008 köpte Kalle en ny LCD-teve. I kartongen fanns (förutom teven och dess tillbehör) en plastpåse full med bruksanvisningar.

Bruksanvisningarna var tryckta i A5-format. De var sju till antalet; fyra vikblad märkta "Quick Start" (sex språk på varje) samt tre volymer (åtta språk i varje) med ett intetsägande foto på en teve.

Tillsammans vägde bruksanvisningarna 1375 gram. De innehöll samma information 24 gånger, på olika språk.

Men, ingenstans i bruksanvisningarna fanns det någon produktreferens eller någon produktbeteckning på aktuell modell.

Enda möjligheten Kalle hade att förvissa sig om att han läste rätt bruksanvisning var att jämföra ett intetsägande foto och stiliserad bilder i bruksanvisningarna, med hur den aktuella teven faktiskt såg ut. Det var ett gissningsarbete.

Kalle hade flera olika modeller av teveapparater från samma tillverkare och ville kunna läsa rätt bruksanvisning även när kan inte hade någon av teveapparterna framför sig.
Kalle behövde kunna referera till texten i en av bruksanvisningarna. Då använda han "Document order number", vilket var angivet på baksidan av varje bok.

När man använder bruksanvisningar för säkerhetsrelaterade produkter, måste man kunna säkerställa att man använder rätt instruktion. Samma krav finns även för andra produkter.

Användarscenario 1 belyser betydelsen av att - i god tid före tryckning - ställa krav på bruksanvisningar på samma sätt som vi ställer krav på alla andra delprodukter och produktkomponenter - under utvecklingsfasen. Det är för sent att konstatera att mer information borde ha tagits med - eller utelämnats - när upplagan redan är tryckt.

Vid framtagning av en publikation är det mycket som sker "bakom scenen":

Arbete på väg

Denna sektion är under arbete !

HTML

HyperTextMarkupLanguage

<!DOCTYPE html>
<html>

<head>
  <title>Title of HTML document</title>
  <meta charset="UTF-8">
</head>

<body>
 <!-- Page Content -->
</body>

</html>

HTML-koden är grundläggande för alla html-dokument.

HTML-standarden är en så kallad levande standard och utvecklas fortlöpande, för att anpassas till nya behov och tillämpningar. När detta skrivs (2016) är den senaste standarden HTML5, bestående av drygt 100 taggar.

För att skriva tekniska dokument behöver man inte kunna alla dessa taggar. Det tar tid att lära sig dem, främst därför att det finns små skillnader i hur de implementerats, i olika Webläsare. Det är därför effektivast av låta något programvarupaket hanterar detaljerna. En grundläggande förståelse för hur taggar används är likväl nyttig, inte minst om man vill kunna felsöka och avhjälpa enklare fel i programinställningar.

Vill man kunna handkoda HTML-kod krävs någon form av utbildning. Grunderna är dock mycket enkla.

En Start-tag består av ett tag-namn, angivet mellan två hakparenteser: <tag-namn>

En Slut-tag består av samma tag-namn, angivet mellan två hakparenteser, med en inledande "slash": </tagnamn>

En tag består av tre delar:

Start-tag - Exempel: <head>
Tag innehåll - Exempel: Se ovan.
Slut-tag - Exempel: </head>

<tag-namn>Tag innehåll</tag-namn>

Enligt HTML5 behöver vissa taggar inte en Slut-tag, utan är "självavslutande" (selfclosing).

Taggar, utan innehåll kan förkortas till <tag /> (Observera mellanslaget)

Mekanikföretaget Bult och Skruv har utvecklat en ny plåtbockningsmaskin. De behöver en användarbeskrivning för att uppfylla EU-direktivet.

Behov: Användarbeskrivning

Varför: Juridik, Säkerhet, Installation, Underhåll, Drift

Arbete på väg

Denna sektion är under arbete !

Ordförklaringar

.html-dokument

HTML-kod

HTML5

Print On Demand

selfclosing

Självavslutande HTML-tag.

HTML-tag som inte kräver någon Slut-tag. Främst <br> och <hr>, men även andra taggar kan vara själv självavslutande, delvis beroende på vilken tag de förekommer i.