Teknik belge yazma ile deneme yazma arasındaki fark nedir?


cevap 1:

Teknik dokümantasyon, teknik yazının ürünüdür. Teknik Yazı, çeşitli teknik alanlarda kullanılan teknik iletişimin yazılı biçimini tanımlayan bir terimdir - bilgisayar yazılımı ve donanımı, kimya, havacılık, mühendislik, robotik, finans, vb. Bazı insanlar bu terimi "basit bir şekilde karmaşık şeyler yazmak" form".

Teknik yazma, teknik yazarlar veya nasıl da denir - teknik iletişimciler tarafından yapılır. Bu meslek eleştirel düşünme, yazma becerileri ve daha pek çok beceri gerektirir.

Geçmişte, teknik belgeler çoğunlukla yazılıp çevrimdışı görüntüleniyordu. Ürünle birlikte bir dosya olarak gönderilir (yazılım ürünleri için) veya ürünle birlikte basılı olarak teslim edilir. Son on yılda, kullanıcı kılavuzlarının çoğu çevrimiçi dokümantasyon portallarına taşınmaya başladı.

Teknik yazmanın temel amacı, kullanıcıların bir ürün kullanarak hedeflerine ulaşmalarına yardımcı olmaktır. Sadece açık ve yorumlanması kolay belgelerle mümkündür. Bu yüzden çok farklı türde belgeler var. İster acemi ister deneyimli bir teknoloji yazarı olun, en popüler belge türlerini bilmelisiniz, çünkü her tür farklı içerik, stil vb.

Bu nedenle, teknik yazarlar birçok belge içerdiği için teknik dokümantasyon yazma konusunda çeşitli becerilere sahip olmalıdır.

~ Kaynak: Teknik Yazı Nedir?

Deneme yazmak da o kadar kolay değil, bir konuyu beyin fırtınası yapmalı, bir araştırma yapmalısın. Ancak, teknik altyapıya sahip olmanız veya yazmak için özel bir araç kullanmanız gerekmez, MS Word yeterli olabilir.


cevap 2:

Bunun için kalifiye olduğumu düşünüyorum, çünkü son işimde, son birkaç ay boyunca yaptığım bir sürü iş için oldukça uzun bir Teknik / Şartname Belgesi yazdım, bu da her şeyi belgelemek zorunda olduğumdan beri oldukça uzun oldu özel VPC'ler, Veritabanı kurulumları, Ters proxy'ler vb.

Bir makalede genellikle kaynaklara atıfta bulunuyorsunuz, sunulan bilgi ve ifadeler üzerinde bazı analizler yapıyorsunuz ve daha sonra eldeki konuya kendi puanlarınızı sunuyorsunuz. Örneğin:

Kitap Adı'nda (Lewis ve Clark) yazar “daha ​​sonra“ bir şey hakkında bir noktaya işaret eder ”(s. # Pg. ##), daha sonra“ o nokta hakkında biraz fazladan bilgi ”olduğunu açıklar (s. # Pg. ##). Bu, [mevcut makalenin yazarının yaptığı bir noktadır], bu nedenle [yükselen okyanus sıcaklıkları veya başka herhangi bir şeyle] ilişkilendirebileceğimizi gösterir.

Teknik bir belgede, bir şeyin nasıl işlediğine dair çok teknik şeyler ve kendilerini gösterebilecek “gotcha'lar” yazıyorsunuz. Kendi işimden bunun düzeltilmiş bir versiyonu:

Aşağıdaki şekilde, [uygulama adı / kısaltma] gösterge tablosuna müşteri girişine dayalı veri akışı gösterilmektedir. Bu isabet, bir API Ağ Geçidi uç noktasını tetikler ve [bu verileri işlemek] için bir Lambda işlevi başlatır. Bunun [bazı çalışma süreleri] ile düzgün çalışması için bazı özel koşulların yapılması gerekiyordu. D noktasında (şemada etiketlenmiştir), gerekli kontrollerin validasyonu geçmediği tespit edilirse, akışın durduğunu ve [bazı tablo] 'da [bazı diğer gösterge paneli / gevşek kanallar] üzerinden görülebilecek istisnaları günlüğe kaydettiğini unutmayın.

Bana göre, Teknik Belgeler bir deneme gibi geliyor, bir makalede yapmanıza izin verilen tüm alıntılar veya gerekli görsel yardımlar ise. Teknik bir belgede (çoğu durumda) gerçekten bir görüş yeri yoktur ve bir tartışma veya açıklama olması gereken garip değişiklik üzerinde oldukça kısa olma eğilimindedir, örneğin “[x platformu] kullandım” buna rağmen [diğer platform / hizmetlere] geçişin uzun vadede daha hızlı ve daha uygun maliyetli olacağını düşünüyorum. ”


cevap 3:

Herhangi bir yazıdaki # 1 kez kitlenizi belirlemektir. Üçüncü sınıf öğrencileri izleyenlere, üniversite öğrencilerine göre, yaz tatillerinde sahilde bulunan insanlara, fabrikalarına monte edilen yeni bir makine hakkında bilgi edinmesi gereken vasıflı işçilerden farklı yazacaksınız.

Deneme yazma ile teknik belge yazma arasındaki fark, dinleyicidir ve belgenin neyi başarmasıdır.


cevap 4:

Bu düşünmeye değer bir sorudur. Size en azından kendi zihnim ve deneyimlerimle, bu sorunun neye bağlı olduğunu söyleyeyim.

Teknik belge yazma ile deneme yazma arasındaki fark, birine nasıl hayatta kalacağını ve neden hayatta kalacağını açıklama arasındaki farktır.

Yazmaya devam etmeye cazipim ama olmayacak.