Dim ond set o erthyglau yw dogfennaeth meddalwedd. Ond gallant hyd yn oed eich gyrru'n wallgof. Yn gyntaf, rydych chi'n treulio amser hir yn chwilio am y cyfarwyddiadau angenrheidiol. Yna rydych chi'n deall y testun aneglur. Rydych chi'n gwneud fel y'i hysgrifennwyd, ond nid yw'r broblem wedi'i datrys. Rydych chi'n chwilio am erthygl arall, rydych chi'n mynd yn nerfus... Awr yn ddiweddarach rydych chi'n rhoi'r gorau i bopeth ac yn gadael. Dyma sut mae dogfennaeth wael yn gweithio. Beth sy'n ei wneud fel hyn a sut i'w drwsio - darllenwch o dan y toriad.
Roedd llawer o ddiffygion yn ein hen ddogfennaeth. Rydym wedi bod yn ei ail-weithio ers bron i flwyddyn bellach fel nad yw'r senario a ddisgrifir uchod yn effeithio ar ein cleientiaid. Edrych, и .
Problem 1: Erthyglau aneglur, wedi'u hysgrifennu'n wael
Os yw'r ddogfennaeth yn amhosibl ei deall, beth yw ei phwynt? Ond nid oes neb yn ysgrifennu erthyglau annealladwy yn bwrpasol. Maent yn digwydd pan nad yw'r awdur yn meddwl am y gynulleidfa a'r pwrpas, yn arllwys dŵr ac nid yw'n gwirio'r testun am wallau.
- Y gynulleidfa. Cyn ysgrifennu erthygl, mae angen i chi feddwl am lefel paratoi'r darllenydd. Mae'n rhesymegol na ddylech hepgor camau sylfaenol mewn erthygl ar gyfer dechreuwr a gadael termau technegol heb esboniad, ond mewn erthygl ar nodwedd brin sydd ei angen ar weithwyr proffesiynol yn unig, ni ddylech esbonio ystyr y gair PHP.
- Nod. Un peth arall i feddwl amdano ymlaen llaw. Rhaid i'r awdur osod nod clir, pennu effaith ddefnyddiol yr erthygl, a phenderfynu beth fydd y darllenydd yn ei wneud ar ôl ei ddarllen. Os na wneir hyn, byddwch yn y pen draw yn cael disgrifiad er mwyn disgrifiad.
- Dŵr a chwilod. Mae llawer o wybodaeth ddiangen a biwrocratiaeth, mae gwallau a theipos yn ymyrryd â chanfyddiad. Hyd yn oed os nad yw'r darllenydd yn natsïaid gramadeg, gall diofalwch yn y testun ei ddiffodd.
Ystyriwch yr awgrymiadau uchod, a bydd yr erthyglau'n dod yn gliriach - gwarantedig. I'w wneud hyd yn oed yn well, defnyddiwch ein .
Problem 2. Nid yw erthyglau yn ateb pob cwestiwn
Mae'n ddrwg pan nad yw'r ddogfennaeth yn cadw i fyny â datblygiad, nad yw'n ateb cwestiynau go iawn, ac nad yw gwallau ynddo'n cael eu cywiro am flynyddoedd. Mae'r rhain yn broblemau nid yn gymaint o ran yr awdur, ond yn hytrach trefniadaeth prosesau o fewn y cwmni.
Nid yw dogfennaeth yn cyd-fynd â datblygiad
Mae'r nodwedd eisoes yn cael ei rhyddhau, mae cynlluniau marchnata i'w gorchuddio, ac yna mae'n ymddangos nad yw'r erthygl neu'r cyfieithiad newydd yn y ddogfennaeth o hyd. Roedd yn rhaid i ni hyd yn oed ohirio'r datganiad oherwydd hyn. Gallwch ofyn i bawb drosglwyddo tasgau i ysgrifenwyr technegol ar amser cymaint ag y dymunwch, ond ni fydd yn gweithio. Os nad yw'r broses yn awtomataidd, bydd y sefyllfa'n ailadrodd ei hun.
Rydym wedi gwneud newidiadau i YouTrack. Yr awdur technegol sy'n gyfrifol am y dasg o ysgrifennu erthygl am nodwedd newydd ar yr un funud ag y mae'r nodwedd yn dechrau cael ei phrofi. Yna mae marchnata yn dysgu amdano er mwyn paratoi ar gyfer dyrchafiad. Daw hysbysiadau hefyd i negesydd corfforaethol Mattermost, felly mae'n amhosibl colli newyddion gan ddatblygwyr.
Nid yw'r ddogfennaeth yn adlewyrchu ceisiadau defnyddwyr
Rydym wedi arfer â gweithio fel hyn: daeth nodwedd allan, buom yn siarad amdano. Disgrifiwyd sut i'w droi ymlaen, ei ddiffodd, a gwneud addasiadau mân. Ond beth os yw cleient yn defnyddio ein meddalwedd mewn ffordd nad oeddem yn ei ddisgwyl? Neu a oes ganddo gamgymeriadau na wnaethom feddwl amdanynt?
Er mwyn sicrhau bod y ddogfennaeth mor gyflawn â phosibl, rydym yn argymell dadansoddi ceisiadau am gefnogaeth, cwestiynau ar fforymau thematig, ac ymholiadau mewn peiriannau chwilio. Bydd y pynciau mwyaf poblogaidd yn cael eu trosglwyddo i awduron technegol fel y gallant ategu erthyglau sy'n bodoli eisoes neu ysgrifennu rhai newydd.
Nid yw dogfennaeth yn cael ei gwella
Mae'n anodd ei wneud yn berffaith ar unwaith; bydd camgymeriadau o hyd. Gallwch obeithio am adborth gan gwsmeriaid, ond mae'n annhebygol y byddant yn adrodd am bob teip, anghywirdeb, erthygl annealladwy neu ddi-sail. Yn ogystal â chleientiaid, mae gweithwyr yn darllen y ddogfennaeth, sy'n golygu eu bod yn gweld yr un gwallau. Gellir defnyddio hwn! Y cyfan sydd angen i chi ei wneud yw creu amodau lle bydd yn hawdd riportio problem.
Mae gennym grŵp ar y porth mewnol lle mae gweithwyr yn gadael sylwadau, awgrymiadau a syniadau ar ddogfennaeth. A oes angen erthygl ar gefnogaeth, ond nid yw'n bodoli? A wnaeth y profwr sylwi ar yr anghywirdeb? A yw'r partner wedi cwyno i reolwyr datblygu am wallau? Pawb yn y grŵp yma! Mae ysgrifenwyr technegol yn trwsio rhai pethau ar unwaith, yn trosglwyddo rhai pethau i YouTrack, ac yn rhoi amser i eraill feddwl amdanynt. Er mwyn atal y pwnc rhag marw, rydym yn eich atgoffa o bryd i'w gilydd o fodolaeth y grŵp a phwysigrwydd adborth.
Problem 3. Mae'n cymryd amser hir i ddod o hyd i'r erthygl gywir.
Nid yw erthygl nas gellir ei chanfod yn ddim gwell nag erthygl na ellir ei chanfod. Dylai arwyddair dogfennaeth dda fod yn “Hawdd ei chwilio, hawdd dod o hyd iddo.” Sut i gyflawni hyn?
Trefnwch y strwythur a phenderfynwch ar yr egwyddor ar gyfer dewis pynciau. Dylai'r strwythur fod mor dryloyw â phosibl fel nad yw'r darllenydd yn meddwl, "Ble gallaf ddod o hyd i'r erthygl hon?" I grynhoi, mae dau ddull: o'r rhyngwyneb ac o'r tasgau.
- O'r rhyngwyneb. Mae'r cynnwys yn dyblygu adrannau'r panel. Roedd hyn yn wir yn yr hen ddogfennaeth system ISP.
- O dasgau. Mae teitlau erthyglau ac adrannau yn adlewyrchu tasgau'r defnyddwyr; Mae teitlau bron bob amser yn cynnwys berfau ac atebion i'r cwestiwn “sut i”. Nawr rydym yn symud i'r fformat hwn.
Pa bynnag ddull a ddewiswch, gwnewch yn siŵr bod y pwnc yn berthnasol i'r hyn y mae defnyddwyr yn chwilio amdano a'i fod yn cael ei gynnwys mewn ffordd sy'n mynd i'r afael yn benodol â chwestiwn y defnyddiwr.
Sefydlu chwiliad canolog. Mewn byd delfrydol, dylai chwilio weithio hyd yn oed pan fyddwch chi'n camsillafu neu'n gwneud camgymeriad gyda'r iaith. Ni all ein chwiliad yn Confluence hyd yn hyn ein plesio â hyn. Os oes gennych lawer o gynhyrchion a bod y ddogfennaeth yn gyffredinol, teilwriwch y chwiliad i'r dudalen y mae'r defnyddiwr arni. Yn ein hachos ni, mae'r chwiliad ar y brif dudalen yn gweithio ar gyfer pob cynnyrch, ac os ydych chi eisoes mewn adran benodol, yna dim ond ar gyfer yr erthyglau ynddi.
Ychwanegu cynnwys a briwsion bara. Mae'n dda pan fydd gan bob tudalen ddewislen a briwsion bara - llwybr y defnyddiwr i'r dudalen gyfredol gyda'r gallu i ddychwelyd i unrhyw lefel. Yn yr hen ddogfennaeth system ISP, roedd yn rhaid i chi adael yr erthygl i gyrraedd y cynnwys. Roedd yn anghyfleus, felly fe wnaethom ei osod yn yr un newydd.
Rhowch ddolenni yn y cynnyrch. Os daw pobl i gefnogi dro ar ôl tro gyda'r un cwestiwn, mae'n gwneud synnwyr ychwanegu awgrym gyda'i ateb i'r rhyngwyneb. Os oes gennych ddata neu fewnwelediad i pan fydd defnyddiwr yn cael problem, gallwch hefyd roi gwybod iddynt gyda rhestr bostio. Dangos pryder iddynt a chymryd y baich oddi ar gefnogaeth.
Ar y dde yn y ffenestr naid mae dolen i erthygl am sefydlu DNSSEC yn adran rheoli parth ISPmanager
Sefydlu croesgyfeiriadau o fewn dogfennaeth. Dylai erthyglau sy'n ymwneud â'i gilydd fod yn “gysylltiedig”. Os yw'r erthyglau'n ddilyniannol, gwnewch yn siŵr eich bod chi'n ychwanegu saethau ymlaen ac yn ôl ar ddiwedd pob testun.
Yn fwyaf tebygol, bydd person yn gyntaf yn mynd i chwilio am ateb i'w gwestiwn nid i chi, ond i beiriant chwilio. Mae'n drueni os nad oes dolenni i'r ddogfennaeth yno am resymau technegol. Felly gofalwch am optimeiddio peiriannau chwilio.
Problem 4. Mae gosodiad hen ffasiwn yn amharu ar ganfyddiad
Yn ogystal â thestunau gwael, gall dogfennau gael eu difetha gan ddyluniad. Mae pobl yn gyfarwydd â darllen deunyddiau sydd wedi'u hysgrifennu'n dda. Blogiau, rhwydweithiau cymdeithasol, cyfryngau - mae'r holl gynnwys yn cael ei gyflwyno nid yn unig yn hardd, ond hefyd yn hawdd ei ddarllen ac yn bleserus i'r llygad. Felly, gallwch chi ddeall poen person sy'n gweld testun fel yn y sgrin isod yn hawdd.
Mae cymaint o sgrinluniau ac uchafbwyntiau yn yr erthygl hon nad ydyn nhw'n helpu, ond yn ymyrryd â chanfyddiad yn unig (gellir clicio ar y llun)
Ni ddylech wneud darlleniad hir o'r ddogfennaeth gyda llawer o effeithiau, ond mae angen i chi ystyried y rheolau sylfaenol.
Gosodiad. Pennu lled testun y corff, ffont, maint, penawdau a phadin. Llogi dylunydd, ac i dderbyn y gwaith neu ei wneud eich hun, darllenwch lyfr Artyom Gorbunov “Typography and Layout.” Mae'n cyflwyno un olwg yn unig o'r gosodiad, ond mae'n eithaf digonol.
Dyraniadau. Penderfynwch beth sydd angen pwyslais yn y testun. Yn nodweddiadol mae hwn yn llwybr yn y rhyngwyneb, botymau, mewnosodiadau cod, ffeiliau ffurfweddu, blociau “Noder”. Penderfynwch beth fydd dyraniadau'r elfennau hyn a chofnodwch nhw yn y rheoliadau. Cofiwch, y lleiaf o ryddhad, gorau oll. Pan mae llawer ohonyn nhw, mae'r testun yn swnllyd. Mae hyd yn oed dyfynodau yn creu sŵn os cânt eu defnyddio'n rhy aml.
Screenshots. Cytuno gyda'r tîm ym mha achosion y mae angen sgrinluniau. Yn bendant nid oes angen darlunio pob cam. Mae nifer fawr o sgrinluniau, gan gynnwys. botymau ar wahân, ymyrryd â chanfyddiad, difetha'r gosodiad. Darganfyddwch faint, yn ogystal â fformat yr uchafbwyntiau a'r llofnodion ar sgrinluniau, a chofnodwch nhw yn y rheoliadau. Cofiwch y dylai darluniau bob amser gyfateb i'r hyn a ysgrifennwyd a bod yn berthnasol. Unwaith eto, os caiff y cynnyrch ei ddiweddaru'n rheolaidd, bydd yn anodd cadw golwg ar bawb.
Hyd testun. Osgowch erthyglau rhy hir. Rhannwch nhw yn rhannau, ac os nad yw hyn yn bosibl, ychwanegwch gynnwys gyda dolenni angor i ddechrau'r erthygl. Ffordd syml o wneud erthygl yn fyrrach yn weledol yw cuddio manylion technegol sydd eu hangen ar gylch cul o ddarllenwyr o dan sbwyliwr.
Fformatau. Cyfunwch sawl fformat yn eich erthyglau: testun, fideo a delweddau. Bydd hyn yn gwella'r canfyddiad.
Peidiwch â cheisio cuddio problemau gyda chynllun hardd. Yn onest, roeddem ni ein hunain yn gobeithio y byddai'r “lapiwr” yn arbed y dogfennau hen ffasiwn - ni weithiodd allan. Roedd y testunau'n cynnwys cymaint o sŵn gweledol a manylion diangen fel bod y rheoliadau a'r dyluniad newydd yn ddi-rym.
Bydd llawer o'r uchod yn cael ei bennu gan y platfform a ddefnyddiwch ar gyfer dogfennaeth. Er enghraifft, mae gennym Gydlifiad. Roedd yn rhaid i mi tincer gydag ef hefyd. Os oes gennych ddiddordeb, darllenwch stori ein datblygwr gwe: .
Ble i ddechrau gwella a sut i oroesi
Os yw eich dogfennaeth mor helaeth â systemau ISP ac nad ydych chi'n gwybod ble i ddechrau, dechreuwch gyda'r problemau mwyaf. Nid yw cleientiaid yn deall y ddogfen - gwella'r testunau, gwneud rheoliadau, hyfforddi ysgrifenwyr. Mae'r dogfennau wedi dyddio - cymerwch ofal o brosesau mewnol. Dechreuwch gyda'r erthyglau mwyaf poblogaidd am y cynhyrchion mwyaf poblogaidd: gofynnwch am gefnogaeth, edrychwch ar ddadansoddiadau safle ac ymholiadau mewn peiriannau chwilio.
Gadewch i ni ddweud ar unwaith - ni fydd yn hawdd. Ac mae'n annhebygol o weithio'n gyflym chwaith. Oni bai eich bod chi newydd ddechrau a gwneud y peth iawn ar unwaith. Un peth rydyn ni'n ei wybod yn sicr yw y bydd yn gwella dros amser. Ond ni fydd y broses byth yn dod i ben :-).
Ffynhonnell: hab.com