Kuidas kirjutada veebikeskkonna spetsifikatsiooni
Aeg-ajalt osalen erinevate veebikeskkondade loomisel. Aja jooksul on välja kujunenud struktuur, kuidas kirjeldada selle funktsionaalsust.
- Spetsifikatsiooni üldine osa
- veebikeskkonna või muudatuste eesmärk
- Info platvormi jt süsteemi puudutavate asjade kohta (nt lehekülgede aadresside kuju, toimimise ja navigatsiooni üldised põhimõtted, sh mitu keelt ning kuidas toimub ühe keele keskkonnast üleminek teise)
- Millised teised süsteemid ja kuidas on arendatava veebiga seotud
- Keskkonna ühised elemendid
- Päis
- Jalus
- Teised elemendid, mis enamikel lehekülgedel ühised
- Admini ühised elemendid, nt kasutajahaldus ja üldiste elementide häälestamine
- Rubriigitüüpide kirjeldus
- rubriigitüübi nimi
- keskmise veeru kirjeldus
- kui on erandeid p 2 võrreldes, siis need
- admin: Kuidas toimub rubriikide seadistamine? Kas saab luua uusi rubriigitüüpe? Kui jah, siis kuidas? Kuidas määratakse ära, milline rubriik kus asub?
- Artiklitüüpide kirjeldus
- tüübi nimi
- keskmise veeru kirjeldus
- kui on erandeid p 2 võrreldes, siis need
- admin: kuidas toimub artikli sisestamine, parandamine, kustutamine? Iga tüübi puhul ka erandid kõige tavalisema artikli sisestamisest.
- Esilehe kirjeldus
- Milline näeb välja keskmine veerg?
- Mis juhtub, kui mingile elemendile klõpsan?
- Millised on erandid p 2 ja p 3?
- admin: kuidas sisestatakse artikleid esilehele?
- admin: kui esilehe komponente saab muuta, siis kuidas?
- Rubriigipuu
- Milline on menüüsüsteem, millised jaotused selles on?
- Millist tüüpi rubriik või artikkel avaneb konkreetsele menüüle klõpsamisel? Mida kuvatakse keskmises veerus? Mis juhtub, kui kuskile klõpsan?
- Millised on erandid p 2 ja p 3?
- admin: millised on erinõudmised selle rubriigi adminile?
- Suhtlus
- Kuidas toimib RSS?
- Kuidas saavad kasutajad uuendusmeili vms?
- Kui on kasutusel mobiilsed lahendused, kuidas need toimivad?
- Teised olulised asjad
- kas mingid asjad on enne kirjeldamata, mille jaoks pole korralikku kohta?
- Viimane lihv: kirjuta specis lahti kõik kohad, kuhu kogemata kirjutasid enne "ja nii edasi" :)
Olen igati tänulik, kui asjatundlikud inimesed võtavad kommentaarides oma kogemusi ja soovitusi jagada. Ehk saavad siis asjaarmastajaist keskkondade kirjeldajad edaspidi oma soove arendajatele paremini kirjeldatud.
Lisalugemiseks:
5 kommentaari:
Lisan paar asja, mida mina kohe lambist juurde küsiksin. Mõned on vbla spetsiifilisemad ega ei peaks ehk üldspekis olema, aga noh, kui sul on ideid vaja, siis... Esiteks asenda "keskmine veerg" määratlusega "sisu- või põhiveerg", vältimaks probleeme, kui tähenärimiseks läheb ja suhted nugade peal on. Soovitan erilist tähelepanu pöörata sisestusele, juba sisestatud andmete töötlemisele ja õigustesüsteemile.
* mis juhtub, kui sisuveergu sisu ära ei mahu (suur pilt, murdmata rida)?
* millised on artikli sisestamisel kohustuslikud elemendid? millisel tasemel toimub kontroll (nt kas pealkirjaks tohib olla punkt või nähtamatu sümbol?)
* millised artikli elemendid on leitavad otsinguga?
* kas otsing toimib reaalajas või regulaarselt koostatava indeksi alusel? kui seda viimast, siis kas otsinguindeksit saab ka erakorralisel ajal (st ettenähtude aegade vahel) uuendada? kes seda teha saavad?
* õigustesüsteemi olemasolul - kas õigusi saab kasutajaliidese kaudu (st mitte otse baasis mäkerdades) delegeerida? aga ära võtta?
* kas sisuobjekte (artiklid/pildid) on võimalik töödelda (nt peitmine, õiguste määramine) hulgi?
* millised on elementidele, üksustele ja sisestatavate andmetele esitatavad piirangud/nõudmised? kui pikk tohib olla pealkiri ilma, et see kujundust lõhuks? kas rubriikide arv on piiratud? aga üksuste arv rubriigis?
* kas on võimalik sisestada duplikaate, nt identse nimega üksusi, nt juhul kui kasutajal õnnestub vormi kaks korda submittida? kas neid on võimalik ka liideses eristada (nt id abil)?
* mis juhtub autori artiklitega, kui autor süsteemist kustutada?
* kas rubriikide avalehti on võimalik kustutada? aga peidetuks määrata? mis juhtub sel juhul avalikus veebis?
* mis juhtub kujundusega, kui mingil põhjusel nt kujunduses kasutatavaid pilte ei õnnestu laadida. kas tekst on loetav? rubriigid klikitavad/kasutatavad?
* kas veebimaterjalidele (pildid, dokumendid) saab hotlinkida? kas seda saab keelata?
* kas ja kellel on võimalik määrata aadressialiaseid, nt et foo.com/kampaania viitaks lehele foo.com/2007/reklaamiosakond/projektid/klaabu?
* kui keeruline on muuta ajutiselt kujundust, nt jõulukampaania ajaks?
jne
miks alustada nullist kui saab kasutada olemasolevat ja seda täiendada? ümber kujundada? (vabavara siis)
coding is so overrated
Aitäh Aabramile heade märkuste eest!
Toivo, selleks, et vabavaraga midagi teha, pead ikkagi kirjeldama, mida sa sellega teha tahad :)
aabram pani kirja päris mitu asja, mida küll poleks tarvis kasutajalt küsida...
* mis juhtub autori artiklitega, kui autor süsteemist kustutada?
* mis juhtub kujundusega, kui mingil põhjusel nt kujunduses kasutatavaid pilte ei õnnestu laadida. kas tekst on loetav? rubriigid klikitavad/kasutatavad?
* millised artikli elemendid on leitavad otsinguga?
ja umbes sellised asjad, mida vist peaks spetsifikatsioonis kirjeldama, aga ma küll ei kujuta ette, et seda peaks kasutaja käest küsima. selle kohta on võib siis kah jälle spolskyt linkida:
http://www.joelonsoftware.com/items/2006/11/21.html
Mina sain aru, et neid küsimusi küsitakse ikka arendajalt. Veebikeskkonna funktsionaalsuse paneb kirja ikka arendaja, mitte kasutaja. Nimetatud asjad on need, mille üle kasutajad pärast tulist kurja vannuvad, kui need arendamise käigus läbi mõtlemata jäetud või kuidagi iseenesest random lahendusega realiseeritud. Nähtud küll neid keskkondi, kus pärast näiteks pärast viimase elemendi kustutamist haru nähtamatuks muutub ja seega kättesaamatuks, et sinna näiteks uuesti mõni element sisestada...
Postita kommentaar