Teknik Şartname Nasıl Yazılır (Resimli)

İçindekiler:

Teknik Şartname Nasıl Yazılır (Resimli)
Teknik Şartname Nasıl Yazılır (Resimli)

Video: Teknik Şartname Nasıl Yazılır (Resimli)

Video: Teknik Şartname Nasıl Yazılır (Resimli)
Video: Profesyonel Ses Sistemi (Pasif Sistem) için Doğru ve Yanlış Bağlantı Şekilleri 2024, Mart
Anonim

Teknik şartname (tech spec), bir ürünün veya projenin ne yapacağını ve bu hedeflere nasıl ulaşacağınızı açıklayan bir belgedir. Bir teknik spesifikasyonda, müşterinize ve ekip üyelerinize hangi sorunu çözdüğünüzü, projeniz veya ürününüz için hedefleri veya gereksinimleri ve bunu nasıl başarmayı planladığınızı gösterin. Bir teknik özellik, yapılacak işi yönlendirir ve projeniz ilerledikçe genellikle onu yeniden yazarsınız.

adımlar

Bölüm 1/3: Başlığınızı Yazma

Teknik Şartname Yazın Adım 1
Teknik Şartname Yazın Adım 1

Adım 1. Proje adını 14 punto veya 16 punto sans serif yazı tipi kullanarak en üste koyun

Bu, ürününüzün adı veya projenin kendisinin çalışma başlığıdır. 14-pt veya 16-pt olarak bir sans serif yazı tipi kullanın, böylece okunması kolay olur. Tercihlerinize bağlı olarak sola yaslayın veya ortalayın.

İş yeriniz veya eğitmeniniz size başlığınızı nasıl yazacağınızı gösteren bir şablon sağlayabilir. Varsa, her zaman şablonu takip edin

Biliyor musun?

Bir sans serif yazı tipinin harfler üzerinde son vuruşları yoktur, bu nedenle bu stiller daha modern bir görünüme sahiptir. En popüler sans serif yazı tipleri Arial, Calibri ve Verdana'dır.

Teknik Şartname Yazın 2. Adım
Teknik Şartname Yazın 2. Adım

Adım 2. Tarihi proje adının altına 12 punto sans serif yazı tipiyle yazın

Bir sonraki satıra gidin ve yazı tipi boyutunuzu 12 puntoya küçültün. Proje adınızı yazarken kullandığınız aynı sans serif yazı tipini kullanın. Ardından, ay, gün ve yılı kullanarak tarihi yazın.

  • Şablonunuz farklıysa tarihinizi şablona göre biçimlendirin.
  • Hangi teknik özelliğin en yeni olduğunu söyleyebilmeniz için tarihleri eklemek önemlidir.
Teknik Şartname Yazın Adım 3
Teknik Şartname Yazın Adım 3

Adım 3. Tarihin altına “Yazar” ve yazarın adını yazın

Bir sonraki satıra gidin ve "Yazar" yazın ve ardından iki nokta üst üste koyun. Ardından, teknik özellikleri yazan siz olduğunuz için adınızı yazın. Teknik özelliklerinizin içeriğini bir ekiple tartışmış olsanız bile, her zaman sadece adınızı girin.

Bir ekiple çalışıyor olsanız bile, bir teknik özelliğin her zaman bir yazarı olması gerekir. Yazar, spesifikasyonu gerçekten yazan kişidir

Teknik Şartname Yazın Adım 4
Teknik Şartname Yazın Adım 4

Adım 4. “Takımı” ve ekip üyelerinin adlarını en sona yerleştirin

Bir sonraki satırda, "Takım" yazıp ardından iki nokta üst üste işareti koyun. Ardından proje veya ürün üzerinde çalışan her ekip üyesinin adını yazın.

  • Ekip üyelerinize kredi vermenin yanı sıra, bu, insanların teknik özelliklerle ilgili soruları olduğunda kime gidebileceklerini anlamalarına yardımcı olur.
  • Bu projede yalnız çalıştıysanız, bu adımı atlayın.

Bölüm 2/3: Teknik Spesifikasyon Taslağı Hazırlamak

Teknik Şartname Yazın Adım 5
Teknik Şartname Yazın Adım 5

Adım 1. Proje veya ürün hakkında bir genel bakış veya kısa bir özet sağlayın

Teknik özelliklerinize, yaptığınız işin bir özetiyle başlayın. Başlık olarak "Genel Bakış" veya "Kısa Özet" yazın. Sorunu açıklayın, ardından proje veya ürünün ne olduğunu ve ne yapacağını özetleyin. Ardından, bunu başarmak için yaklaşımınızın ne olacağını açıklayın ve ekipmansa ürün özelliklerini ekleyin. Proje için önemli olan tüm pazarlama veya mühendislik belgelerine bağlantı verin. Son olarak, projeyi veya ürünü bitirmenin ne kadar süreceğine dair kaba bir zaman tahmini sağlayın.

Şöyle yazabilirsiniz, “İlçe genelinde toplu taşıma gezilerini planlamak için mevcut sistem, sürücüleri zor durumda bırakıyor ve belirli rotalarda yolcu sayısını azaltıyor. Otobüs sistemlerinden ikisi, yolcuların seyahatlerini çevrimiçi olarak planlamasına olanak tanır, ancak üçüncüsü kağıt haritalar ve telefon iletişimini kullanır. Bu çözüm, yolcu sayısını azaltıyor ve yetersiz finansmana neden oluyor, bkz. İlkbahar 2019 anket sonuçları. 3 toplu taşıma hattını da kullanıcıların çevrimiçi olarak erişebilecekleri 1 planlama sistemine taşımak istiyoruz. Bu, seyahatlerini daha kolay planlamalarını ve otobüslerin her durakta ne zaman olacağını görmelerini sağlayacaktır. Ek olarak, sürücüler bir 'bize ulaşın' işlevini kullanarak sorunları anında bildirebilir.”

Teknik Şartname Yazın Adım 6
Teknik Şartname Yazın Adım 6

Adım 2. Genel bakışta veya kısa özette yer almıyorlarsa bir hedefler bölümü ekleyin

Başlık olarak "Hedefler" yazın, ardından projeniz veya ürününüzle neyi başarmayı planladığınızı kısaca özetleyin. Bir giriş ifadesi yazın, ardından hedeflerinizi numaralı veya madde işaretli bir listede listeleyin.

  • Genel bakış bölümünde hedeflerinizi özetlerseniz, genellikle bu bölüme ihtiyacınız olmaz. Ancak iş yeriniz gerektiriyorsa bu bölümü eklemeniz gerekebilir.
  • “Yeni sistem şunları içerecek: 1) Bir rota planlama aracı; 2) Bir veri yolu bulma işlevi; 3) Sürücülerin sorunları bildirmesi için bir yol.”
Teknik Şartname Yazın Adım 7
Teknik Şartname Yazın Adım 7

Adım 3. Ürün gereksinimlerini ayrı bir bölüme yazın

Ardından, başlık olarak "Ürün Gereksinimleri" yazın ve ardından sorununuzu çözmek için ürününüzün yapması gerekenleri yazın. Bir madde işareti listesi kullanın ve bir başlangıç cümlesi için endişelenmeyin.

Örneğin, “1) Rota planlayıcı, sürücülerin yolda kalmamasını ve otobüslerin yeterince kullanılmamasını sağlar; 2) İletişim kutusu, toplu taşıma planlayıcılarının yolcu sorunlarına doğrudan yanıt vermesini sağlar.”

Teknik Şartname Yazın Adım 8
Teknik Şartname Yazın Adım 8

Adım 4. Projenizin kapsamı dışında kalan şeyleri açıklayın

Bu bölüme "Kapsam Dışı" veya "Hedef Olmayanlar" adını verin. Giriş veya paragraf yazmayın. Bunun yerine, sorununuzu çözmek için yapmayacağınız şeylerin bir madde imli listesini oluşturun. Bu, yapmayacağınız işleri, işe yaramayacağını düşündüğünüz çözümleri ve ürün veya projenizin sahip olamayacağı nitelikleri içerir. Müşterinin ve ekibinizin herhangi bir yanlış anlama olmaması için kapsamlı olun.

“1) Bu sistem yeni otobüs güzergahları eklemez; 2) Otobüs duraklarına veya otobüslere bilgisayar kurmayacağız, bu nedenle binicilerin kendi cihazlarını kullanmaları gerekecek; 3) Ulaşım planlayıcıları, sürücü sorunlarına anında çözüm getirmeyi garanti etmeyecektir; ve 4) Bu hizmet, kapıdan kapıya teslim almayı kapsamayacaktır.”

Varyasyon:

Bazen bu bölüm, zaman çizelgesinden önce teknik özelliklerin sonuna yakın bir yere yerleştirilir. Tercih ettiğiniz yerleşimi kullanın veya iş yerinizde en yaygın olanı yapın.

Teknik Şartname Yazın Adım 9
Teknik Şartname Yazın Adım 9

Adım 5. Çözülmemiş sorunlarınız varsa bir "Açık Sorular" bölümü ekleyin

Teknik özellikleriniz, ürün veya projenin hızlı bir taslağıdır, böylece müşteriniz ne elde ettiğini anlar ve ekibiniz aynı hedefler üzerinde çalışır. Her ayrıntıyı dahil etme veya “belirlenmesi gereken” sorularınızı yanıtlama konusunda endişelenmeyin. Bunun yerine, "Açık Sorular" başlığını yazın ve daha sonra karar vereceğiniz şeylerin madde imli listesini sunun.

“1) Sistem güncellemelerini nasıl yöneteceğiz? 2) Bir sorun bulursak rota haritalarını değiştirir miyiz? 3) Sistem, çeviri hatası olmadan çok dilli bir yolcuya hizmet verebilir mi? 4) Teknoloji konusunda bilgili olmayan binicilere en iyi şekilde nasıl hizmet edeceğiz?”

Teknik Şartname Yazın Adım 10
Teknik Şartname Yazın Adım 10

Adım 6. Planınızı "Yaklaşım" bölümünde sunun

Bu bölüme “Plan” veya “Yaklaşım” adını verin. Nihai bir karar verilmemişse, sorunu nasıl çözeceğinizi veya düşündüğünüz farklı yaklaşımları açıklayın. Araştırmanızı ve kullanacağınız her bir teknolojiyi veya süreci açıklayın. Mümkünse, okuyucularınızın planınızı anlamasını kolaylaştırmak için çizimler, çizelgeler ve diyagramlar ekleyin. Son olarak, planınızı nasıl test edeceğinizi ve sorunlar olursa ne yapacağınızı tartışın.

  • Farklı yaklaşımları veya teknolojileri açıklarsanız, planınızı takip etmenin kolay olması için her biri için bir alt bölüm oluşturun.
  • Şuna benzer bir şey yazın: “Sürücülerin varış noktalarını kendileri için bir rota oluşturacak bir uygulamaya girmelerine olanak tanıyan bir yazılım tasarlamak için toplu taşıma planlama ekibiyle birlikte çalışacağız. Sürücüler daha sonra isterlerse rotayı değiştirebilirler. Sistem, rotalarını bulmalarına yardımcı olmak için sürücülere metin güncellemeleri gönderecek. Yazılımı halka sunmadan önce bir paydaş komitesindeki sürücülerin yazılımı test etmesini sağlayacağız. Planda hatalar varsa, otobüslerin çevrimdışı olduğu saatlerde site güncellemeleri yapacağız. Ayrıca sistem nedeniyle mahsur kalan yolcuları almak için ekstra bir servis otobüsümüz olacak” dedi.

Varyasyon:

Planınızın veya yaklaşımınızın neleri içereceğini özetlemek için en üste bir "Bileşenler" bölümü ekleyebilirsiniz. Ancak, şirketiniz veya eğitmeniniz gerektirmediği sürece bu genellikle isteğe bağlıdır.

Teknik Şartname Yazın Adım 11
Teknik Şartname Yazın Adım 11

Adım 7. Düşündüğünüz ancak göz ardı ettiğiniz diğer seçenekleri de dahil edin

Bu bölümü planınızın veya yaklaşımınızın bir alt adımı olarak koyun veya zaman çizelgenizden önce spesifikasyonunuzun sonuna yerleştirin. “Değerlendirilen Diğer Seçenekler” başlığını yazın ve mevcut planınızı seçmeden önce göz önünde bulundurduğunuz alternatifleri açıklayın. Her seçeneği neden reddettiğinizi açıklayın.

"Daha ucuz bir seçenek olduğu için renk kodlu haritaları düşündük, ancak biniciler mevcut haritalara iyi yanıt vermedi ve test grubunun kafası karıştı" yazabilirsiniz

Teknik Şartname Yazın Adım 12
Teknik Şartname Yazın Adım 12

Adım 8. Ürünü veya projeyi değerlendirmek için yöntemlerinizi ve metriklerinizi tanımlayın

Bu bilgileri bir bölüme veya birden çok bölüme ekleyin. "Etkiyi Ölçme" veya "İzleme" ve "Metrikler" gibi bir ad verin. Bir veya daha fazla paragrafta, ürün veya projenizin doğru çalıştığından ve hedeflerinize ulaştığından nasıl emin olacağınızı açıklayın. Ek olarak, hataları veya sorunları nasıl kontrol edeceğinizi açıklayın.

  • Kullanacağınız belirli analitik süreçleri veya teknolojileri dahil edin.
  • Şuna benzer bir şey söyleyin: “Otobüslerin programa uygun olduğundan emin olmak için tahmini rota sürelerini gerçek rota süreleriyle karşılaştıracağız. Ek olarak, memnuniyetlerini değerlendirmek ve sistemle ilgili sorunları belirlemek için bir sürücü anketi yapacağız.”
Teknik Şartname Yazın Adım 13
Teknik Şartname Yazın Adım 13

Adım 9. Güvenliği ve gizliliği nasıl sağlayacağınızı belirleyin

“Güvenlik ve Gizlilik” başlığını yazın, ardından kullanıcıları siber saldırılardan nasıl koruyacağınızı açıklayın. Riskleri ve gizliliğin korunması için sisteminizi nasıl güvence altına alacağınızı kısaca açıklayın. Yöntemlerinizi açıklamak için birkaç paragraf yazın.

  • Her zaman riskler veya endişeler vardır, bu nedenle bu bölüme “risk yoktur” yazmayın.
  • Yazabilirsiniz, “Kullanıcılar konumlarını ve ev adreslerini girecek. Ek olarak, bir profil oluşturma ve gezileri kaydetme seçeneğine sahip olacaklar. Bu verileri korumak için şifreleme ve güvenlik duvarı ekleyeceğiz."
Teknik Şartname Yazın Adım 14
Teknik Şartname Yazın Adım 14

Adım 10. Bir zaman çizelgesi ve kilometre taşları listesi ile bitirin

Zaman çizelgesi, projenizin yolunda gitmesine yardımcı olur ve hem müşterinize hem de ekibinize ne yapılması gerektiğini söyler. Bu bölüme “Zaman Çizelgesi” adını verin, ardından görevleri kimin yaptığına göre ayırın. Tercihlerinize bağlı olarak her ekip veya ekip üyesi için bir madde işareti listesi ekleyin.

  • Örneğin, görev dökümünüz “Mühendislik Ekibi”, “Planlama Ekibi”, “Pazarlama” ve “Kalite Güvencesi”ni listeleyebilir.
  • Mühendislik ekibi için madde listeniz, “1) Web sitesi yükseltmesi yazın; 2) gezi planlama uygulaması yazın; 3) İletişim sistemi yazın.”

Bölüm 3/3: Teknik Özelliklerinizi Sonlandırma

Teknik Şartname Yazın Adım 15
Teknik Şartname Yazın Adım 15

Adım 1. Belgenizi tek boşluk bırakın ve bölümler arasında 1 satır atlayın

Teknik özelliklerinizin daha kısa ve kullanımı daha kolay olması için tek boşluk kullanın. Paragrafları veya bölümleri değiştirmek istediğinizde 1 satır atlamanız yeterlidir. Bu, okuyucunun gereksiz sayfalar eklemeden devam etmesine yardımcı olur.

İş yeriniz veya eğitmeniniz size farklı biçimlendirme talimatları verebilir. Eğer öyleyse, bu talimatları izleyin

Teknik Şartname Yazın Adım 16
Teknik Şartname Yazın Adım 16

Adım 2. Teknik özelliklerinizde birinci şahıs bakış açısı kullanın

Sizin ve ekibinizin başaracağı işleri tartıştığınız için her zaman "ben", "ben", "biz" ve "biz" birinci şahıs zamirlerini kullanın. Belirli bir takımdan veya kişiden bahsederken, kimden bahsettiğinizi netleştirmek için adlarını kullanın. Bu, teknik özellikleri doğrudan ve noktaya tutar, çünkü okuyucu her eylemi nasıl tamamlayacağını bilir.

  • Örneğin, "Teknik özellikleri gerektiği gibi güncelleyeceğiz" yerine "Teknik özellikleri gerektiği gibi güncelleyeceğiz" deyin.
  • Benzer şekilde, "Mühendislik ekibi bir web sitesi yazacak" veya "Amy bir pazarlama planı hazırlayacak" yazın.
Teknik Şartname Yazın Adım 17
Teknik Şartname Yazın Adım 17

Adım 3. Takip etmesi kolay, net ve özlü bir metin yazın

Fikirlerinizi teknik özelliklerde detaylandırmayın çünkü hem sizin hem de okuyucunuzun zamanını boşa harcar. Fikirlerinizi ifade etmek için olabildiğince az kelime kullanın ve düşüncelerinizi takip etmesi kolay olacak şekilde düzenleyin. Raporunuzu gözden geçirin ve raporunuzun daha doğrudan olması için gereksiz ifadeleri ve tekrar eden cümleleri ortadan kaldırın.

Örneğin, "Sürücülerin istedikleri seyahati planlayabilmeleri ve otobüsün takibini yapabilmeleri için bir web sitesi yazacağız" ifadesini "Bu web sitesi yolculuk planlama ve otobüs takibine izin veriyor" şeklinde revize edebilirsiniz

Teknik Şartname Yazın Adım 18
Teknik Şartname Yazın Adım 18

Adım 4. Teknik özelliklerinizi gözden geçirmesi ve geri bildirim sağlaması için bir iş ortağı edinin

Teknik özelliklerinizi, onu anlayacak bir ekip üyesi veya sınıf arkadaşınızla paylaşın. Gördükleri hataları işaretlemelerini isteyin ve nerede iyileştirmeler yapabileceğiniz konusunda size geri bildirimde bulunun.

Alanınızı anlamayan birine teknik özelliklerinizi göstermeyin. Muhtemelen kafaları karışacak ve gerekli olmayan değişiklikleri önerebilirler

Teknik Şartname Yazın Adım 19
Teknik Şartname Yazın Adım 19

Adım 5. Değişiklik gerekiyorsa teknik özelliklerinizi gözden geçirin

Aldığınız geri bildirimlere dayanarak, teknik özelliklerinizi gözden geçirin ve gerekli olduğunu düşünüyorsanız düzeltmeler yapın. Teknik özellikleri müşterileriniz ve ekibiniz için anlaşılır hale getirmeye odaklanın. Ancak, mükemmel olmadığından endişelenmeyin.

Projeniz veya ürününüz ilerledikçe teknik özelliklerinizi güncellemeniz gerekebilir. Bu geçici bir belgedir, bu yüzden asıl işinizi yapmanıza engel olmasına izin vermeyin

Teknik Şartname Yazın Adım 20
Teknik Şartname Yazın Adım 20

Adım 6. Dağıtmadan önce teknik özelliklerinizi gözden geçirin

Hataları kontrol etmek için teknik özelliklerinizi en az iki kez okuyun. Yapabiliyorsanız, hatalarınızı yakalamanıza yardımcı olması için yüksek sesle okuyun. Belgenizin anlamını değiştirebilecek yazım hataları veya kelimeler gibi şeylere odaklanın.

Örneğin, "mevcut sistem verimsiz" yerine "mevcut sistem verimli" gibi hataları arayın

Önerilen: