Software Engineering Metrics

Kanuni za mtindo (za pamoja, zinazotekelezeka)

Mtindo wa nyumbani mahali pamoja. Vitu vilivyowekwa alama “(jaribio)” vinatekelezwa na tests/validate.py; ukiukaji unashindwa kujenga. Toleo kamili la simulizi ni spec/conventions.md kwenye mzizi wa hazina.

Kanuni kali

  • Hakuna vistari virefu (em-dash). Usitumie kistari kirefu (U+2014) kamwe. Tumia koma, nukta pacha, mabano, au sentensi mbili. Vistari vifupi (en-dash) ”–” vinaruhusiwa tu katika safu za namba kama 1–9 au 2.1–2.8. (jaribio)
  • Hakuna misemo ya kawaida. Usitumie “not only … but also”, “but also”, au “load-bearing”. Epuka “It’s important to note”, “In today’s fast-paced world”, “It’s crucial to consider”, “It appears that”, “One could argue”, na fomula ya “it’s not just X, it’s Y”. (jaribio, kwa tatu za kwanza)
  • Fafanua istilahi unapoitumia mara ya kwanza. Panua vifupisho na ufafanue msamiati wa kitaalamu mara ya kwanza kila mada inapoutumia, kwa mfano “wastani wa muda wa kupona (MTTR).”
  • Unganisha dhana muhimu na Wikipedia unapozitaja mara ya kwanza, mara moja kwa kila mada, katika maandishi tu. Umbo: [term](https://en.wikipedia.org/wiki/Article_Title). Kamwe si katika vichwa, majedwali, msimbo, au sehemu ya marejeo. (umbo la kiungo ni jaribio)
  • Marejeo halisi tu. Mwandishi na kichwa cha kazi halisi. Hakuna vichwa, waandishi, au URL za kubuni.
  • Taja njia ya kuchezea. Mada ya familia ya vipimo inataja jinsi kipimo kinavyochezewa na kizuizi gani kinakamata hilo (mada ya 1.2).

Sauti

  • Joto, la moja kwa moja, la kutia moyo. Msemeshe msomaji kama “wewe.” Sentensi fupi, maneno rahisi. Anza na hoja.
  • Lenye msimamo na la vitendo. Lisilopendelea muuzaji. Taja bidhaa kama mifano ya ukweli tu.

Muundo (jaribio)

  • Mada za maudhui zinatumia mpangilio kamili wa sehemu katika chapter-template.md.
  • Kichwa cha kwanza ni # N.M Title (namba ya mada yenye nukta), na kinalingana na kiambishi cha PP-CC kilichojazwa sifuri cha faili.
  • Namba ndani ya kila sehemu hazina mapengo na zinaanza kwa N.0.

Baada ya kuhariri

  • Ukibadilisha seti ya mada, sasisha spec/structure.md na uendeshe just nav.
  • Endesha just test daima.