Hugbúnaðarskjöl eru bara sett af greinum. En jafnvel þeir geta gert þig brjálaðan. Í fyrsta lagi eyðir þú löngum tíma í að leita að nauðsynlegum leiðbeiningum. Þá skilurðu óljósa textann. Þú gerir eins og skrifað er, en vandamálið er ekki leyst. Þú leitar að annarri grein, verður stressaður... Klukkutíma síðar gefst þú upp á öllu og fer. Svona virkar slæm skjöl. Hvað gerir þetta svona og hvernig á að laga það - lestu undir skurðinum.
Það voru margir annmarkar á gömlu skjölunum okkar. Við höfum verið að endurvinna það í næstum ár þannig að atburðarásin sem lýst er hér að ofan hefur ekki áhrif á viðskiptavini okkar. Sjáðu, и .
Vandamál 1: Óljósar, illa skrifaðar greinar
Ef ekki er hægt að skilja skjölin, hvað er þá tilgangurinn með þeim? En enginn skrifar óskiljanlegar greinar viljandi. Þeir gerast þegar höfundur hugsar ekki um áhorfendur og tilgang, hellir vatni og athugar ekki textann fyrir villum.
- Áhorfendur. Áður en þú skrifar grein þarftu að hugsa um undirbúningsstig lesandans. Það er rökrétt að í grein fyrir byrjendur ættir þú ekki að sleppa grunnskrefunum og skilja tæknileg hugtök eftir án skýringa, en í grein um sjaldgæfan eiginleika sem aðeins fagmenn þurfa, ættir þú að útskýra merkingu orðsins PHP.
- Markmið. Eitt í viðbót til að hugsa um fyrirfram. Höfundur verður að setja sér skýr markmið, ákvarða gagnleg áhrif greinarinnar og ákveða hvað lesandinn gerir eftir að hafa lesið hana. Ef þetta er ekki gert, endar þú með lýsingu til lýsingar.
- Vatn og pöddur. Það er mikið af óþarfa upplýsingum og skrifræði, villur og innsláttarvillur trufla skynjun. Jafnvel þótt lesandinn sé ekki málfræðinasisti getur kæruleysi í textanum slökkt á honum.
Íhugaðu ráðin hér að ofan og greinarnar verða skýrari - tryggt. Til að gera það enn betra skaltu nota okkar .
Vandamál 2. Greinar svara ekki öllum spurningum
Það er slæmt þegar skjölin fylgja ekki þróuninni, svara ekki raunverulegum spurningum og villur í þeim eru ekki leiðréttar í mörg ár. Þetta eru vandamál ekki svo mikið höfundar heldur skipulag ferla innan fyrirtækisins.
Skjöl fylgja ekki þróuninni
Eiginleikinn er þegar kominn út, markaðssetning ætlar að ná yfir hann og þá kemur í ljós að nýja greinin eða þýðingin er enn ekki í skjölunum. Við þurftum meira að segja að fresta útgáfunni vegna þessa. Þú getur beðið alla um að afhenda tæknihöfundum verkefni á réttum tíma eins mikið og þú vilt, en það mun ekki virka. Ef ferlið er ekki sjálfvirkt mun ástandið endurtaka sig.
Við höfum gert breytingar á YouTrack. Verkefnið að skrifa grein um nýjan eiginleika fellur á tæknihöfundinn á sama augnabliki og byrjað er að prófa eiginleikann. Síðan lærir markaðssetning um það til að undirbúa kynningu. Tilkynningar berast einnig til Mattermost fyrirtækjaboðberans, svo það er einfaldlega ómögulegt að missa af fréttum frá þróunaraðilum.
Skjöl endurspegla ekki beiðnir notenda
Við erum vön að vinna svona: eiginleiki kom út, við ræddum um það. Við lýstum því hvernig á að kveikja á því, slökkva á því og gera fínstillingar. En hvað ef viðskiptavinur notar hugbúnaðinn okkar á þann hátt sem við áttum ekki von á? Eða eru villur sem við hugsuðum ekki um?
Til að tryggja að skjölin séu eins fullkomin og mögulegt er, mælum við með því að greina stuðningsbeiðnir, spurningar um þemaspjallborð og fyrirspurnir í leitarvélum. Vinsælustu efnin verða færð yfir á tæknihöfunda svo þeir geti bætt við núverandi greinum eða skrifað nýjar.
Ekki er verið að bæta skjöl
Það er erfitt að gera það fullkomlega strax; það verða samt mistök. Þú getur vonast eftir viðbrögðum frá viðskiptavinum, en það er ólíklegt að þeir muni tilkynna hverja innsláttarvillu, ónákvæmni, óskiljanlega eða ófundna grein. Auk viðskiptavina lesa starfsmenn skjölin, sem þýðir að þeir sjá sömu villurnar. Þetta er hægt að nota! Þú þarft bara að búa til aðstæður þar sem auðvelt er að tilkynna vandamál.
Við erum með hóp á innri gáttinni þar sem starfsmenn skilja eftir athugasemdir, ábendingar og hugmyndir um skjöl. Þarf stuðningur grein, en hún er ekki til? Tók prófunarmaðurinn eftir ónákvæmninni? Hefur samstarfsaðilinn kvartað til þróunarstjóra yfir villum? Allt í þessum hópi! Tækniritarar laga suma hluti strax, flytja suma hluti yfir á YouTrack og gefa öðrum tíma til að hugsa um. Til að koma í veg fyrir að efnið deyi, minnum við öðru hvoru á tilvist hópsins og mikilvægi endurgjöf.
Vandamál 3. Það tekur langan tíma að finna réttu greinina.
Grein sem ekki er að finna er ekkert betri en grein sem ekki er að finna. Einkunnarorð góðrar skjala ættu að vera "Auðvelt að leita, auðvelt að finna." Hvernig á að ná þessu?
Skipuleggðu uppbygginguna og ákvarðaðu meginregluna fyrir val viðfangsefna. Uppbyggingin ætti að vera eins gagnsæ og mögulegt er svo að lesandinn hugsi ekki: "Hvar get ég fundið þessa grein?" Til að draga saman, þá eru tvær aðferðir: frá viðmótinu og frá verkefnum.
- Frá viðmótinu. Innihaldið afritar spjaldið. Þetta var raunin í gömlu ISPsystem skjölunum.
- Frá verkefnum. Heiti greina og hluta endurspegla verkefni notenda; Titlar innihalda næstum alltaf sagnir og svör við spurningunni „hvernig á að“. Nú erum við að fara yfir í þetta snið.
Hvaða nálgun sem þú velur, vertu viss um að efnið sé viðeigandi fyrir það sem notendur eru að leita að og sé fjallað um það á þann hátt sem tekur sérstaklega á spurningu notandans.
Settu upp miðlæga leit. Í ákjósanlegum heimi ætti leit að virka jafnvel þegar þú stafsetur rangt eða gerir mistök með tungumálið. Leit okkar í Confluence hingað til getur ekki þóknast okkur með þetta. Ef þú átt margar vörur og skjölin eru almenn, sníðaðu leitina að síðunni sem notandinn er á. Í okkar tilviki virkar leitin á aðalsíðunni fyrir allar vörur, og ef þú ert nú þegar í ákveðnum hluta, þá aðeins fyrir greinarnar í honum.
Bætið við innihaldi og brauðrasp. Það er gott þegar hver síða hefur valmynd og brauðmola - leið notandans að núverandi síðu með getu til að fara aftur á hvaða stig sem er. Í gömlu ISPsystem skjölunum þurfti að hætta í greininni til að komast að innihaldinu. Það var óþægilegt, svo við redduðum því í nýja.
Settu tengla í vöruna. Ef fólk kemur til að styðja aftur og aftur með sömu spurningunni er skynsamlegt að bæta við vísbendingu með lausn þess við viðmótið. Ef þú hefur gögn eða innsýn í hvenær notandi lendir í vandræðum geturðu líka látið hann vita með póstlista. Sýndu þeim umhyggju og taktu byrðina af stuðningi.
Hægra megin í sprettiglugganum er hlekkur á grein um uppsetningu DNSSEC í lénsstjórnunarhluta ISPmanager
Settu upp krosstilvísanir í skjölum. Greinar sem tengjast hver annarri ættu að vera „tengdar“. Ef greinarnar eru í röð, vertu viss um að bæta fram og aftur örvum í lok hvers texta.
Líklegast mun einstaklingur fyrst leita að svari við spurningu sinni, ekki til þín, heldur leitarvélar. Það er synd ef það eru engir tenglar á skjölin þar af tæknilegum ástæðum. Svo sjáðu um leitarvélabestun.
Vandamál 4. Gamaldags skipulag truflar skynjun
Til viðbótar við slæman texta getur skjöl verið spillt með hönnun. Fólk er vant því að lesa vel skrifað efni. Blogg, samfélagsnet, fjölmiðlar - allt efni er ekki aðeins fallegt heldur einnig auðvelt að lesa og gleður augað. Þess vegna geturðu auðveldlega skilið sársauka einstaklings sem sér texta eins og á skjámyndinni hér að neðan.
Það eru svo margar skjámyndir og hápunktar í þessari grein að þeir hjálpa ekki, heldur trufla aðeins skynjun (myndin er smellanleg)
Þú ættir ekki að gera langan lestur úr skjölunum með fullt af áhrifum, en þú þarft að taka tillit til grundvallarreglnanna.
Skipulag. Ákvarða meginmálsbreidd, leturgerð, stærð, fyrirsagnir og fyllingu. Ráðið hönnuður og til að samþykkja verkið eða gera það sjálfur, lesið bók Artyom Gorbunov „Typography and Layout“. Það sýnir aðeins eina sýn á skipulagið, en það er alveg nóg.
Úthlutanir. Ákveðið hvað þarf að leggja áherslu á í textanum. Venjulega er þetta slóð í viðmótinu, hnappar, kóðainnskot, stillingarskrár, „Vinsamlegast athugið“ blokkir. Ákveðið hver úthlutun þessara þátta verður og skráið þær í reglugerð. Hafðu í huga að því minni útferð, því betra. Þegar þeir eru margir er textinn hávær. Jafnvel gæsalappir skapa hávaða ef þær eru notaðar of oft.
Skjámyndir. Sammála teyminu í hvaða tilvikum þarf skjáskot. Það er sannarlega óþarfi að útskýra hvert skref. Mikill fjöldi skjámynda, þ.m.t. aðskildir hnappar, trufla skynjun, spilla skipulaginu. Ákvarðu stærð, sem og snið hápunkta og undirskrifta á skjámyndum, og skráðu þau í reglugerð. Mundu að myndir eiga alltaf að vera í samræmi við það sem skrifað er og eiga við. Aftur, ef varan er uppfærð reglulega, verður erfitt að fylgjast með öllum.
Lengd texta. Forðastu of langar greinar. Skiptu þeim í hluta og ef það er ekki mögulegt skaltu bæta við efni með akkerartengla í byrjun greinarinnar. Einföld leið til að gera grein sjónrænt styttri er að fela tæknilegar upplýsingar sem þröngur hringur lesenda þarf undir skemmu.
Snið. Sameina nokkur snið í greinum þínum: texta, myndskeið og myndir. Þetta mun bæta skynjunina.
Ekki reyna að hylja vandamál með fallegu skipulagi. Í hreinskilni sagt, vonuðum við sjálf að „umbúðirnar“ myndu bjarga úreltum skjölum - það gekk ekki upp. Textarnir innihéldu svo mikinn sjónrænan hávaða og óþarfa smáatriði að reglugerðir og ný hönnun voru máttlaus.
Mikið af ofangreindu ræðst af vettvangnum sem þú notar fyrir skjöl. Til dæmis höfum við Confluence. Ég þurfti líka að fikta við hann. Ef þú hefur áhuga, lestu sögu vefhönnuðarins okkar: .
Hvar á að byrja að bæta sig og hvernig á að lifa af
Ef skjölin þín eru eins mikil og ISPsystem og þú veist ekki hvar þú átt að byrja skaltu byrja á stærstu vandamálunum. Viðskiptavinir skilja ekki skjalið - bæta textana, setja reglur, þjálfa rithöfunda. Skjöl eru úrelt - sjá um innri ferla. Byrjaðu á vinsælustu greinunum um vinsælustu vörurnar: spurðu stuðning, skoðaðu vefgreiningar og fyrirspurnir í leitarvélum.
Segjum strax - það verður ekki auðvelt. Og það er ólíklegt að það virki fljótt heldur. Nema þú sért nýbyrjaður og gerir það rétta strax. Eitt sem við vitum fyrir víst er að það mun lagast með tímanum. En ferlið mun aldrei taka enda :-).
Heimild: www.habr.com