Sainigh Cuspóirí go Soiléir
Ar an leathanach seo
Cinneann Soiléireacht an Chuspóra an Toradh
Ní leor a rá cad atá le déanamh i leide éifeachtach do grok-build-0.1; caithfidh tú cur síos a dhéanamh ar an rud atá tú ag iarraidh a bhaint amach. Is difríocht bhreá ach bhunúsach í seo: fágann an “cad” go mbíonn ar an tsamhail tuairimíocht a dhéanamh faoi do chuid ionchais, ach tugann an “toradh ionchais” sprioc bheacht di.
An Baol a Bhaineann le Cuspóirí Doiléire
Breathnaigh ar an sampla seo:
“Cruthaigh rianaire bia”
Caithfidh an tsamhail tuairimíocht a dhéanamh: cén cineál comhéadain? Cé na gnéithe? Cén leibhéal mionsonraithe don rianú? Cén teicneolaíocht? Táirgeoidh sí rud éigin, ach is í a fisic den tionscadal a bheidh ann, ní do cheannsa.
Anois, le cuspóir soiléir:
“Cruthaigh rianaire bia a thaispeánann briseadh síos laethúil na gcalraí de réir cothaitheach nuair a chuireann mé bia isteach. Ba mhaith liom forbhreathnú ginearálta agus treochtaí ardleibhéil.”
Tá a fhios ag an tsamhail go beacht cad atá tú ag súil leis: ionchur bia, ríomh calraí, briseadh síos cothaitheach, amharc laethúil, agus treochtaí. Is féidir léi toradh ábhartha a tháirgeadh ón gcéad atriall.
Teicnící chun Cuspóirí Soiléire a Fhoirmliú
Cur síos a dhéanamh ar an Toradh Deiridh
In ionad cur síos a dhéanamh ar an ngníomh (“cuir gné leis”), déan cur síos ar an rud a fheicfidh an t-úsáideoir nó ar an rud a dhéanfaidh an cód:
- Doiléir: “Cuir leathanú leis”
- Soiléir: “Nuair a sháraíonn an liosta 20 mír, taispeáin cnaipeanna Roimhe/Ar Aghaidh ag an mbun. Caithfear an leathanach reatha a aibhsiú. Caithfidh an URL an leathanach gníomhach a léiriú le ?page=N”
Saincheisteanna a Shonrú
Cuireann srianta deireadh le doiléire:
- “Gan aon spleáchais nua a chur leis”
- “Comhoiriúnacht siarghabhálach le API v1 a choinneáil”
- “Caithfidh an t-am freagartha fanacht faoi 200ms”
- “Comhoiriúnach le Node.js 18+“
Samplaí Ionchuir/Aschuir a Chur ar Fáil
Agus tú ag obair ar chlaochlú sonraí nó ar fheidhm úsáide, is fiú sampla amháin míle focal:
“Cruthaigh feidhm a chlaochlaíonn slug go teideal. Sampla: ‘my-blog-post’ → ‘My Blog Post’. Ní dhéantar focail nasctha (of, the, a) a chaipitiú mura bhfuil siad sa chéad suíomh.”
Sonraigh Cad nach dTeastaíonn Uait
Uaireanta, tá sé chomh húsáideach céanna a rá cad nach dteastaíonn uait agus a rá cad atá uait:
“Déan athchóiriú ar an gcomhpháirt chun hooks a úsáid, ach ná athraigh an comhéadan poiblí (na props). Caithfidh tástálacha atá ann cheana leanúint ar aghaidh ag rith gan aon mhodhnú.”
Cuspóirí Casta a Struchtúrú
D’iarratais a bhaineann le hathruithe iolracha, struchtúraigh do chuspóirí i gcéimeanna nó i bpointí:
“Ba mhaith liom an córas fíordheimhnithe a nuachóiriú:
- Seisióin fianáin a athsholáthar le JWTanna
- Token athnuachana le rothlú a chur leis
- An bealach /logout a choinneáil feidhmiúil
- Téann na tokenanna in éag tar éis 15 nóiméad”
Is cuspóir inthomhaiste gach pointe is féidir leis an tsamhail a fhíorú.
Príomhphointí
- Déan cur síos ar an toradh ionchais, ní hamháin ar an ngníomh atá le déanamh
- Cuir srianta leis chun doiléire a dhíbirt
- Cuir samplaí ionchuir/aschuir ar fáil nuair is ábhartha
- Liostaigh na rudaí nach dteastaíonn uait a mhodhnú
- Struchtúraigh cuspóirí casta i bpointí uimhrithe