Агуулгын хүснэгт:

Техникийн баримт бичгийг хэрхэн бэлтгэдэг вэ?
Техникийн баримт бичгийг хэрхэн бэлтгэдэг вэ?

Видео: Техникийн баримт бичгийг хэрхэн бэлтгэдэг вэ?

Видео: Техникийн баримт бичгийг хэрхэн бэлтгэдэг вэ?
Видео: ЗАБРОШЕННАЯ ОГРОМНАЯ В/Ч ВСЁ БРОСИЛИ 2024, Арванхоёрдугаар сар
Anonim

Үзэгчиддээ зориулж бичих: Ашиглах техникийн баримт бичгийг бүрдүүлэх 6 алхам

  1. Төлөвлөлт. Эхлэхээсээ өмнө төслийн зорилго, хамрах хүрээг мэдэж аваарай.
  2. Төсөл боловсруулах. Бүх сэдвийн талаар өндөр түвшний тоймоор эхэл.
  3. Хянаж байна.
  4. Шинэчилж байна.
  5. Засварлах.
  6. Нийтлэх/засварлах.

Энгийнээр, техникийн баримт бичигт юу оруулах ёстой вэ?

Техникийн бичих нь өргөн хүрээний баримт бичгийг агуулдаг. Үүнд заавар, тойм, тайлан, мэдээллийн товхимол, танилцуулга, вэб хуудас, товхимол, санал, захидал, хуудас, график, санамж бичиг, хэвлэлийн мэдээ, гарын авлага, тодорхойлолт, загварын гарын авлага, хэлэлцэх асуудал гэх мэт.

Нэмж дурдахад та төслийн баримт бичгийг хэрхэн бэлтгэх вэ? Төслөө баримтжуулах шилдэг туршлагууд

  1. агуулсан README файлыг оруулна уу.
  2. Бусдад асуудал хянагчийг зөвшөөрөх.
  3. API баримт бичгийг бичнэ үү.
  4. Кодоо баримтжуулах.
  5. Файлын зохион байгуулалт, тайлбар, нэрлэх конвенц, програмчлалын практик гэх мэт кодчиллын конвенцуудыг хэрэглээрэй.
  6. Хувь нэмэр оруулагчдад зориулсан мэдээллийг оруулна уу.

Хоёрдугаарт, техникийн баримт бичгийг бүрдүүлэх гэж юу вэ?

Техникийн баримт бичиг аль нэгийг хэлнэ баримт бичиг Энэ нь бүтээгдэхүүний хэрэглээ, функциональ байдал, бүтээх, эсвэл архитектурыг тайлбарладаг. Үүнийг хэрэглэгчид, шинээр ажилд орсон хүмүүс, админууд болон таны бүтээгдэхүүн хэрхэн ажилладагийг мэдэх шаардлагатай бусад хүмүүст зориулсан "хэрхэн" гарын авлага гэж бодоорой.

Би баримт бичгийн ур чадвараа хэрхэн сайжруулах вэ?

Тиймээс, энд бичиг баримтаа нэн даруй сайжруулахад танд болон танай багт туслах хэдэн энгийн бөгөөд хурдан зөвлөгөө байна

  1. Зөвлөмж 1) Идэвхгүй дуу хоолойгоор үүнийг зогсоо.
  2. Зөвлөгөө 2) Уншигчийн анхаарлыг татахын тулд энгийн дүрслэлийг ашигла.
  3. Зөвлөгөө 3) Гайхалтай гарчиг, сумыг ашигла.
  4. Зөвлөгөө 4) Товчилсон үг болон Buzz үгсээ номхотгох.
  5. Зөвлөгөө 5) Дахин гүйцэтгэлийн стандартыг ашигла.

Зөвлөмж болгож буй: