Mitä ohjelmistoja tarvitset tuotteen online -dokumentaation luomiseen? On olemassa laaja valikoima ammattityökaluja, jotka palvelevat tämän tehtävän tarpeita. Clickhelp.com on esimerkki tällaisista ohjelmistoista (ja vielä enemmän täydellisestä ympäristöstä), sinun on luotava online-dokumentaatio helposti.
Yhteistyöympäristö
Riittää, kun asennat OpenOffice.orgin tai jonkin sen lukuisista ilmaisista vaihtoehdoista, jotta voit luoda asiakirjoja yksin paikalliselle koneellesi. Mutta kun kyseessä on valtava joukko teknisiä asiakirjoja suurelle projektille, se vaatii paljon enemmän. Vaikka hoidat vain yhtä projektia, on ensinnäkin useita kirjoittajia ja suunnittelijoita, jotka ovat vastuussa asiakirjojen eri osista. Toiseksi on arvostelijoita ja toimittajia, jotka valvovat kirjailijoiden työtä. Kolmanneksi on olemassa ohjelmiston kehittäjiä, joiden on pysyttävä yhteydessä dokumentointiosastoon. Jos projekti on monikielinen (mikä on loogista maailmanlaajuiselle tuotteelle), tarvitaan myös kääntäjiä. Lopuksi on johtajia, jotka hallitsevat prosesseja.
Heidän kaikkien pitäisi tuntea olonsa mukavaksi yhtenäisessä pilviympäristössä. On olemassa erilaisia ominaisuuksia, jotka voivat muuttaa pilvipalvelun tallennustilalla ja editorilla tällaiseksi ympäristöksi:
- Sisäänrakennettu lähetin. Kaikkien pitäisi pysyä yhteydessä. Tällaisen messengerin avulla voit lähettää sisäisiä linkkejä, kuvakaappauksia, yrityskalenterin tapahtumia ja niin edelleen. Lähettämäsi tiedot pysyvät turvassa.
- Ajoitustyökalut. Sinun on nimettävä tapahtumia, annettava tehtäviä, seurattava niiden tilaa, asetettava määräaikoja, annettava tehtävät uudelleen muille asiantuntijoille (tarvittaessa), tarkistettava, kuinka kiireisiä he ovat ja niin edelleen.
- Mukautettava työnkulku. Voi olla erilaisia tehtäviä, jotka vaativat erilaisia ryhmiä ja erilaisia lähestymistapoja.
On myös tärkeää tehdä tästä palvelusta monialustainen, etenkin lukituskaudella, jolloin kaikki menee etänä. Työntekijät tuovat nyt vain omia laitteitaan: he työskentelevät kotoa käsin mitä tahansa tai tarvitsevat. Joten verkkotyökalujen on oltava käytettävissä kaikkien suosituimpien Windows-, Mac- tai Linux -selainten kautta. Voi olla mobiilisovellus, joka yhdistää messengerin, kalenterin, muokattavan editorin ja kaiken tarvittavan.
Muokattavat editorit
Ohjelmistojen online -dokumentaatiossa tulee väistämättä esiin ohjeet, jotka määrittelevät tuloksen. Jotkut niistä määräytyvät puhtaan käytettävyyden mukaan, toiset tulevat ohjelmistokohtaisista ominaisuuksista, ja joskus vaaditaan, että asiakirjat pidetään yrityksesi tyyliin. Dokumentaation helpottamiseksi ja nopeuttamiseksi voit valita vain sen tekemiseen tarvittavat työkalut.
Mitä voit poistaa toimittajilta? Jotkin muotoiluvaihtoehdot ja fontit voivat olla tarpeettomia. Kaikkein tarpeellisimmat ominaisuudet voidaan asettaa muiden eteen, joten niihin on helpoin päästä käsiksi. Fontit näkyvät taajuusjärjestyksessä, joten kysytyimmät tulevat ensin. Sinun on ehkä vaihdettava se koodinäkymään tai voit tuntea olosi hyväksi pelkästään visuaalisen editorin avulla. Lopuksi voit luoda erilaisia versioita editorista sijainnista riippuen. Tekniset kirjoittajat esimerkiksi käyttävät vain perusversiota, kun taas toimittajat ja johtajat voivat muokata sivuja suuremmalla työkaluvalikoimalla.
Mallit
Voit harkita asiakirjojen suunnittelua tyhjästä ainoana keinona. Mallit voivat kuitenkin säästää tuhansia tunteja jo olemassaolollaan. Hyvä malli voi vaatia hyvin vähän muutoksia, jotka sopivat tarpeisiisi ja näyttävät haluamallesi. Dokumentaatio on tietysti ensisijaisesti toimivaa, ja suunnittelijoiden kokeille ei ole juurikaan tilaa. Silti vapautta on riittävästi.
Ei vain malleja dokumentaatioportaalin sivuille. Voi olla editorin kokoonpanoja, työnkulun malleja ja niin edelleen. Kaikki muokattavissa on parempi pari esimerkkiä.
Mallit ovat itse asiassa vain osa monitasoista rakennetta. Jos haluat luoda asiakirjasi nopeasti, sinun on voitava tehdä se muutamassa minuutissa mallien, tuontityökalujen ja pikamuokkainten avulla. Mutta jos haluat muokata sitä syvemmälle, saatat tarvita enemmän ammattimaisia työkaluja, joiden avulla voit muokata ja säätää sekä sisältöä että käytettävyyttä.
Lopullinen käytettävyys
On tärkeää tehdä asiakirjojen luomisesta helppoa. On kuitenkin tärkeää, että valmiit asiakirjat ovat asiakkaiden helppokäyttöisiä. Joten käyttämäsi ohjelmiston (tai pikemminkin palvelun) pitäisi tukea käytettävyyttä parantavia ominaisuuksia. Ne voivat sisältää:
- Dokumentaation ylläpito. Sanomattakin on selvää, että sen pitäisi tarjota riittävästi tilaa ja mukava integrointi pääsivustollesi.
- Live -chat. Jos asiakkaalla on kysyttävää, hänen on voitava kysyä se suoraan sivulta, jolla se syntyi, tai kaikkein osuvimmalta sivulta.
- Hälytykset. Kun uusi versio saapuu, sinun tulee ilmoittaa siitä asiakkaille.
- Vietävyys. Online -dokumentaatio on hienoa, mutta jos asiakkaasi haluaa paikallisen kopion, hänen pitäisi pystyä lataamaan CHM -versio, PDF -tiedosto tai Web -ohje isännöimään omalla palvelimellasi.
- Kolmannen osapuolen palveluiden integrointi. Jos aiot myydä tuotteesi maailmanlaajuisesti, voit integroida automaattisen käännöksen. Jos kommentteja on odotettavissa, voit lisätä Disquksen tai muita kolmansien osapuolten kommenttiympäristöjä.
Hinnasto
Tuskin voi olla mitään sopivampaa SaaS -malliin kuin ohjelmisto online -dokumentaation luomiseksi. Pilvipohjainen määritelmän mukaan se tarjoaa enemmän kuin vain asiakirjojen luontityökaluja. Toimittajien mukana tulee etuja, kuten sisäänrakennettu lähetin, hallintatyökalut, pilvitallennustila asiakirjoille ja muuta. Ei ihme, että sen ylläpito tekee tilauksesta loogisimman vaihtoehdon.
Silti on olemassa erilaisia maksuvaihtoehtoja, ei vain määrien lisäksi myös joustavuutta. Voit säästää enemmän, jos tilaat vain tarvitsemasi ominaisuudet.
Docs
Online -dokumentaatio on tehokkaampaa kuin paikalliset staattiset asiakirjat, mutta sen luominen ja ylläpito vaatii enemmän vaivaa. Ei ihme, että sen työkalut ovat myös erityisiä. Mutta mitä selkeämpi kuva tulevasta dokumentaatioportaalista on, sitä helpompi on löytää oikea ohjelmisto sen kehittämiseksi ja ylläpitämiseksi tuotteen kehittyessä. Kaikissa asiakirjojen luomiseen liittyvissä ohjelmistoissa on työkalu sinulle.
