Proje dok\u00fcmantasyonu, yaz\u0131l\u0131m geli\u015ftirme s\u00fcrecinin ayr\u0131lmaz bir par\u00e7as\u0131d\u0131r ancak s\u0131kl\u0131kla g\u00f6z ard\u0131 edilir veya g\u00fcncelli\u011fini yitirir. Peki, ya dok\u00fcmantasyonunuzun her zaman g\u00fcncel, do\u011fru ve tutarl\u0131 oldu\u011funu otomatik olarak denetleyebilseydiniz? Statik dok\u00fcmantasyon denetleyicileri, bu hayali ger\u00e7e\u011fe d\u00f6n\u00fc\u015ft\u00fcrerek teknik bor\u00e7lar\u0131 azalt\u0131r, geli\u015ftirici verimlili\u011fini art\u0131r\u0131r ve projenizin uzun vadeli s\u00fcrd\u00fcr\u00fclebilirli\u011fini garantiler.<\/p>\n
Yaz\u0131l\u0131m d\u00fcnyas\u0131nda, harika bir \u00fcr\u00fcn in\u015fa etmek kadar, o \u00fcr\u00fcn\u00fcn nas\u0131l \u00e7al\u0131\u015ft\u0131\u011f\u0131n\u0131, nas\u0131l kullan\u0131laca\u011f\u0131n\u0131 ve nas\u0131l s\u00fcrd\u00fcr\u00fclece\u011fini a\u00e7\u0131k\u00e7a belgelemek de b\u00fcy\u00fck \u00f6nem ta\u015f\u0131r. Ne yaz\u0131k ki, dok\u00fcmantasyon s\u00fcre\u00e7leri genellikle yorucu, zaman al\u0131c\u0131 ve hataya a\u00e7\u0131k olabilir. Bir geli\u015ftirici olarak kod yazmaya ay\u0131rd\u0131\u011f\u0131n\u0131z zaman\u0131n, dok\u00fcmantasyonu g\u00fcncelleme veya yeni \u00f6zellikler i\u00e7in belge olu\u015fturma gereksinimiyle b\u00f6l\u00fcnd\u00fc\u011f\u00fcn\u00fc ka\u00e7 kez deneyimlediniz? Ya da bir projeye yeni kat\u0131ld\u0131\u011f\u0131n\u0131zda, kar\u015f\u0131la\u015ft\u0131\u011f\u0131n\u0131z eski, eksik veya yan\u0131lt\u0131c\u0131 dok\u00fcmantasyon y\u00fcz\u00fcnden saatler harcad\u0131\u011f\u0131n\u0131z oldu mu? \u0130\u015fte bu senaryolar, dok\u00fcmantasyonun sadece bir “ek i\u015f” olmad\u0131\u011f\u0131n\u0131, aksine projenin hayati bir par\u00e7as\u0131 oldu\u011funu ve yetersizli\u011finin ciddi maliyetleri olabilece\u011fini g\u00f6sterir. Yanl\u0131\u015f veya g\u00fcncel olmayan dok\u00fcmantasyon, geli\u015ftirme s\u00fcre\u00e7lerini yava\u015flat\u0131r, hatalara yol a\u00e7ar, yeni ekip \u00fcyelerinin adaptasyonunu zorla\u015ft\u0131r\u0131r ve hatta m\u00fc\u015fteri memnuniyetini olumsuz etkileyebilir. Bu sorunlar, projenin b\u00fcy\u00fckl\u00fc\u011f\u00fcne ve karma\u015f\u0131kl\u0131\u011f\u0131na ba\u011fl\u0131 olarak katlanarak artabilir. Bu durumda, manuel denetimler yetersiz kal\u0131r ve hata yapma riski y\u00fckselir.<\/p>\n
Peki, bu g\u00f6r\u00fcnmez tuzaklardan nas\u0131l ka\u00e7\u0131nabiliriz? \u0130\u015fte tam da bu noktada, statik dok\u00fcmantasyon denetleyicileri devreye girer. Bu ara\u00e7lar, t\u0131pk\u0131 kodunuzu analiz eden statik kod analiz\u00f6rleri gibi, dok\u00fcmantasyon dosyalar\u0131n\u0131z\u0131 otomatik olarak tarar. Tutars\u0131zl\u0131klar\u0131, bi\u00e7imlendirme hatalar\u0131n\u0131, eksik referanslar\u0131 ve hatta belirli kurallara uymayan ifadeleri tespit edebilirler. B\u00f6ylece, dok\u00fcmantasyonunuzun kalitesini s\u00fcrekli olarak y\u00fcksek tutman\u0131za yard\u0131mc\u0131 olurlar. Bu sistemler sayesinde, dok\u00fcmantasyonunuzun yaln\u0131zca bir kerelik bir g\u00f6rev de\u011fil, projenizin ya\u015fam d\u00f6ng\u00fcs\u00fc boyunca ya\u015fayan, nefes alan bir varl\u0131k olmas\u0131n\u0131 sa\u011flayabilirsiniz. Otomatik denetimler, geli\u015ftiricilerin kod yazmaya daha fazla odaklanmas\u0131na olanak tan\u0131rken, dok\u00fcmantasyonun do\u011frulu\u011fu ve g\u00fcncelli\u011fi konusunda i\u00e7 rahatl\u0131\u011f\u0131 sunar. Sonu\u00e7 olarak, statik dok\u00fcmantasyon denetleyicileri, proje s\u00fcrd\u00fcr\u00fclebilirli\u011fi, geli\u015ftirici verimlili\u011fi ve teknik borcun azalt\u0131lmas\u0131 i\u00e7in vazge\u00e7ilmez bir ara\u00e7 haline gelmi\u015ftir. Bu teknolojiler, \u00f6zellikle s\u00fcrekli entegrasyon (CI\/CD) ve s\u00fcrekli da\u011f\u0131t\u0131m (CD) s\u00fcre\u00e7lerinin kritik bir par\u00e7as\u0131 olarak entegre edildi\u011finde, paha bi\u00e7ilmez faydalar sunar. Geli\u015ftirme ekibinizin zaman\u0131ndan tasarruf etmekle kalmaz, ayn\u0131 zamanda projenizin uzun \u00f6m\u00fcrl\u00fc ve anla\u015f\u0131l\u0131r olmas\u0131n\u0131 da sa\u011flar.<\/p>\n
Statik dok\u00fcmantasyon denetleyicisi, temel olarak, dok\u00fcmantasyon dosyalar\u0131n\u0131z\u0131 kaynak kodunuzu analiz eden bir linter veya statik analiz arac\u0131 gibi i\u015fleyen bir yaz\u0131l\u0131md\u0131r. Ad\u0131ndan da anla\u015f\u0131laca\u011f\u0131 gibi, “statik” kelimesi, analiz i\u015fleminin kod veya belge \u00e7al\u0131\u015ft\u0131r\u0131lmadan, yani derleme veya \u00e7al\u0131\u015ft\u0131rma zaman\u0131nda de\u011fil, do\u011frudan dosya i\u00e7eri\u011fi \u00fczerinde yap\u0131ld\u0131\u011f\u0131n\u0131 ifade eder. Bu denetleyiciler, Markdown, reStructuredText, AsciiDoc, HTML veya hatta do\u011fal dil metinleri gibi \u00e7e\u015fitli dok\u00fcmantasyon formatlar\u0131n\u0131 i\u015fleyebilirler. Ama\u00e7lar\u0131, belgenin i\u00e7eri\u011finin belirli kurallara, standartlara ve en iyi uygulamalara uygunlu\u011funu kontrol etmektir. Bu, hem bi\u00e7imsel hem de anlamsal kontrolleri i\u00e7erebilir.<\/p>\n
Peki, bir statik dok\u00fcmantasyon denetleyicisi tam olarak ne yapar ve nas\u0131l \u00e7al\u0131\u015f\u0131r? S\u00fcre\u00e7 genellikle birka\u00e7 ad\u0131mdan olu\u015fur. \u0130lk olarak, ara\u00e7, belirtilen dok\u00fcmantasyon dosyalar\u0131n\u0131 tarar. Bu dosyalar, genellikle projenizin kaynak kod deposunda yer alan Denetleyici bu kurallar\u0131 uygulad\u0131ktan sonra, bulunan sorunlar\u0131 rapor eder. Bu rapor, genellikle bir liste halinde, her bir hatan\u0131n veya uyar\u0131n\u0131n dosya ad\u0131n\u0131, sat\u0131r numaras\u0131n\u0131 ve hatan\u0131n a\u00e7\u0131klamas\u0131n\u0131 i\u00e7erir. Bu sayede, geli\u015ftiriciler veya teknik yazarlar, sorunlu alanlar\u0131 h\u0131zl\u0131ca bulup d\u00fczeltebilirler. Modern statik denetleyicilerin \u00e7o\u011fu, yap\u0131land\u0131rma dosyalar\u0131 (genellikle YAML veya JSON format\u0131nda) arac\u0131l\u0131\u011f\u0131yla y\u00fcksek d\u00fczeyde \u00f6zelle\u015ftirilebilir. Bu, ekiplerin kendi projelerine veya \u015firket standartlar\u0131na \u00f6zg\u00fc kurallar\u0131 tan\u0131mlamas\u0131na olanak tan\u0131r. \u00d6rne\u011fin, bir proje, t\u00fcm ba\u015fl\u0131klar\u0131n belirli bir formatta olmas\u0131n\u0131 veya belirli terimlerin (\u00f6rne\u011fin “kullan\u0131c\u0131” yerine “m\u00fc\u015fteri”) kullan\u0131lmas\u0131n\u0131 isteyebilir. Bu esneklik, statik dok\u00fcmantasyon denetleyicilerini paha bi\u00e7ilmez k\u0131lar \u00e7\u00fcnk\u00fc her projenin dok\u00fcmantasyon ihtiya\u00e7lar\u0131 farkl\u0131l\u0131k g\u00f6sterebilir. Sonu\u00e7 olarak, bu ara\u00e7lar, dok\u00fcmantasyon kalitesini art\u0131rmak, tutarl\u0131l\u0131\u011f\u0131 sa\u011flamak ve manuel denetim y\u00fck\u00fcn\u00fc azaltmak i\u00e7in g\u00fc\u00e7l\u00fc bir mekanizma sunar. S\u00fcrekli entegrasyon (CI) boru hatlar\u0131na entegre edildiklerinde, her kod de\u011fi\u015fikli\u011finde dok\u00fcmantasyonun da otomatik olarak denetlenmesini sa\u011flayarak, g\u00fcncel ve do\u011fru belgelerin s\u00fcrekli olarak sunulmas\u0131n\u0131 garantilerler.<\/p>\n Dok\u00fcmantasyon denetleyicilerini projelerinize entegre etmek, ba\u015flang\u0131\u00e7ta karma\u015f\u0131k gibi g\u00f6r\u00fcnse de, do\u011fru ad\u0131mlarla olduk\u00e7a basit hale getirilebilir. Temel ama\u00e7, dok\u00fcmantasyonunuzu otomatikle\u015ftirilmi\u015f bir \u015fekilde kontrol etmek ve tutarl\u0131l\u0131k sa\u011flamakt\u0131r. Bu b\u00f6l\u00fcmde, pop\u00fcler ara\u00e7lar \u00fczerinden kurulum ve yap\u0131land\u0131rma ad\u0131mlar\u0131n\u0131 ele alaca\u011f\u0131z ve \u00f6rnek bir belge \u00fczerinde denetleme \u00e7al\u0131\u015ft\u0131rma s\u00fcrecini g\u00f6sterece\u011fiz.<\/p>\n Piyasada bir\u00e7ok statik dok\u00fcmantasyon denetleyicisi bulunsa da, Vale ve markdownlint, farkl\u0131 ihtiya\u00e7lara y\u00f6nelik g\u00fc\u00e7l\u00fc ve esnek \u00e7\u00f6z\u00fcmler sunar. Vale, dilbilgisi, stil ve terminoloji kontrol\u00fc konusunda uzmanla\u015fm\u0131\u015fken; markdownlint, Markdown dosyalar\u0131n\u0131n bi\u00e7imlendirme tutarl\u0131l\u0131\u011f\u0131n\u0131 sa\u011flar. Bu iki arac\u0131 birlikte kullanarak kapsaml\u0131 bir denetim s\u00fcreci olu\u015fturabilirsiniz.<\/p>\n Vale, do\u011fal dil denetimi i\u00e7in tercih edilen bir ara\u00e7t\u0131r. Kurulumu i\u015fletim sisteminize g\u00f6re de\u011fi\u015fiklik g\u00f6sterebilir:<\/p>\n <\/code><\/li>\n <\/code><\/li>\n <\/code><\/li>\n<\/ul>\n Vale'i yap\u0131land\u0131rmak i\u00e7in projenizin k\u00f6k dizininde bir <\/code><\/p>\n Bu yap\u0131land\u0131rma, <\/code> komutunu \u00e7al\u0131\u015ft\u0131rabilirsiniz.<\/p>\n markdownlint, Node.js tabanl\u0131 bir linter olup, Markdown dosyalar\u0131ndaki bi\u00e7imlendirme hatalar\u0131n\u0131 bulmak i\u00e7in kullan\u0131l\u0131r. Kurulumu basittir:<\/p>\n <\/code><\/p>\n Yap\u0131land\u0131rma i\u00e7in projenizin k\u00f6k dizininde bir <\/code><\/p>\n Bu yap\u0131land\u0131rma, varsay\u0131lan t\u00fcm kurallar\u0131 etkinle\u015ftirir ancak MD001 (ba\u015fl\u0131k hiyerar\u015fisi) kural\u0131n\u0131 devre d\u0131\u015f\u0131 b\u0131rak\u0131r, MD003 kural\u0131 i\u00e7in \"atx\" stilini zorunlu k\u0131lar ve MD013 (sat\u0131r uzunlu\u011fu) kural\u0131n\u0131 120 karaktere ayarlar ancak kod bloklar\u0131 ve tablolar i\u00e7in bu kural\u0131 uygulamaz.<\/p>\n \u015eimdi, yukar\u0131daki ara\u00e7lar\u0131 kullanarak \u00f6rnek bir Markdown dosyas\u0131 olu\u015ftural\u0131m ve \u00fczerinde denetleme \u00e7al\u0131\u015ft\u0131ral\u0131m. <\/code><\/p>\n Bu bir ba\u011flant\u0131d\u0131r: [Google](http:\/\/google.com).<\/p>\n Bu c\u00fcmlenin sonunda yanl\u0131\u015f bir yaz\u0131m hatas\u0131 var. \u015eimdi bu dosyay\u0131 Vale ve markdownlint ile denetleyelim:<\/p>\n <\/code><\/li>\n <\/code><\/li>\n<\/ul>\n Her iki komut da, yap\u0131land\u0131rma dosyalar\u0131n\u0131za ve belgenizin i\u00e7eri\u011fine g\u00f6re hatalar\u0131 ve uyar\u0131lar\u0131 listeleyecektir. \u00d6rne\u011fin, Vale \"yaz\u0131m hatas\u0131\"n\u0131 tespit edebilir, markdownlint ise bo\u015f sat\u0131r veya ba\u015fl\u0131k stili ile ilgili uyar\u0131lar verebilir. Bu \u00e7\u0131kt\u0131lar sayesinde, dok\u00fcmantasyonunuzu h\u0131zla d\u00fczeltebilir ve standartlara uygun hale getirebilirsiniz. Bu ad\u0131mlar\u0131 uygulayarak, projenize g\u00fc\u00e7l\u00fc bir dok\u00fcmantasyon denetim katman\u0131 eklemi\u015f olacaks\u0131n\u0131z.<\/p>\n Statik dok\u00fcmantasyon denetleyicileri, k\u00fc\u00e7\u00fck ki\u015fisel projelerden b\u00fcy\u00fck \u00f6l\u00e7ekli kurumsal uygulamalara kadar her t\u00fcrl\u00fc geli\u015ftirme ortam\u0131nda de\u011fer katar. \u00d6zellikle karma\u015f\u0131k ve geni\u015f kapsaml\u0131 projelerde, manuel denetimin imkans\u0131z hale geldi\u011fi durumlarda, bu ara\u00e7lar vazge\u00e7ilmez bir hal al\u0131r. Ger\u00e7ek d\u00fcnya senaryolar\u0131 \u00fczerinden bu ara\u00e7lar\u0131n sa\u011flad\u0131\u011f\u0131 faydalar\u0131 daha net g\u00f6rebiliriz.<\/p>\n G\u00fcn\u00fcm\u00fcz\u00fcn k\u00fcresel pazarlar\u0131nda, bir API'nin sadece i\u015flevsel olmas\u0131 yeterli de\u011fildir; ayn\u0131 zamanda farkl\u0131 dillerde ve platformlarda geli\u015ftiriciler taraf\u0131ndan kolayca anla\u015f\u0131labilir ve kullan\u0131labilir olmas\u0131 gerekir. B\u00fcy\u00fck bir teknoloji \u015firketi olan \"GlobalTech\"in, d\u00fcnya \u00e7ap\u0131nda binlerce geli\u015ftirici taraf\u0131ndan kullan\u0131lan kapsaml\u0131 bir REST API'si oldu\u011funu d\u00fc\u015f\u00fcnelim. Bu API'nin dok\u00fcmantasyonu \u0130ngilizce, \u0130spanyolca, Almanca ve Japonca olmak \u00fczere d\u00f6rt farkl\u0131 dilde sunuluyor. Her bir API u\u00e7 noktas\u0131 i\u00e7in ayr\u0131 ayr\u0131 dok\u00fcmanlar, kullan\u0131m \u00f6rnekleri, hata kodlar\u0131 ve kimlik do\u011frulama y\u00f6ntemleri bu dillerde belgelenmi\u015ftir. Yeni \u00f6zellikler eklendi\u011finde veya mevcut API'lerde de\u011fi\u015fiklikler yap\u0131ld\u0131\u011f\u0131nda, t\u00fcm dillerdeki dok\u00fcmantasyonun e\u015f zamanl\u0131 ve hatas\u0131z bir \u015fekilde g\u00fcncellenmesi gerekiyor. Ancak, manuel \u00e7eviri ve g\u00fcncelleme s\u00fcre\u00e7leri, tutars\u0131zl\u0131klara, g\u00fcncelli\u011fini yitirmi\u015f bilgilere ve hatta yanl\u0131\u015f \u00e7evirilere yol a\u00e7abiliyor. Bu durum, geli\u015ftirici deneyimini olumsuz etkiliyor ve destek taleplerini art\u0131r\u0131yordu.<\/p>\n GlobalTech, bu sorunu \u00e7\u00f6zmek i\u00e7in statik dok\u00fcmantasyon denetleyicilerini kullanmaya karar verdi. Vale gibi do\u011fal dil denetleyicilerini ve \u00f6zel olarak geli\u015ftirilmi\u015f kurallar setini, t\u00fcm dillerdeki dok\u00fcmantasyon dosyalar\u0131na uygulad\u0131lar. \u00d6rne\u011fin, Vale, \u0130ngilizce dok\u00fcmanlardaki belirli terminoloji kullan\u0131mlar\u0131n\u0131, dilbilgisi kurallar\u0131n\u0131 ve stil k\u0131lavuzlar\u0131n\u0131 denetlerken, ayn\u0131 zamanda \u00e7evrilmi\u015f dok\u00fcmanlarda da (makine \u00e7evirisi veya insan \u00e7evirisi sonras\u0131) bu dillerin kendi dilbilgisi ve stil kurallar\u0131na uyulup uyulmad\u0131\u011f\u0131n\u0131 kontrol eden \u00f6zel stilleri entegre ettiler. Ayr\u0131ca, t\u00fcm dok\u00fcmanlarda API u\u00e7 noktas\u0131 adlar\u0131, parametreler ve hata kodlar\u0131n\u0131n tutarl\u0131 bir \u015fekilde kullan\u0131ld\u0131\u011f\u0131ndan emin olmak i\u00e7in d\u00fczenli ifadeler (regex) tabanl\u0131 \u00f6zel kurallar tan\u0131mlad\u0131lar. Herhangi bir API de\u011fi\u015fikli\u011fi yap\u0131ld\u0131\u011f\u0131nda, CI\/CD boru hatt\u0131na entegre edilmi\u015f bu denetleyiciler, otomatik olarak \u00e7al\u0131\u015f\u0131r. E\u011fer herhangi bir dildeki dok\u00fcmantasyonda bir tutars\u0131zl\u0131k, eksik bilgi veya dilbilgisi hatas\u0131 bulunursa, boru hatt\u0131 ba\u015far\u0131s\u0131z olur ve ilgili geli\u015ftiriciye bildirim g\u00f6nderilir. Bu sayede, hatal\u0131 veya g\u00fcncel olmayan dok\u00fcmantasyonun yay\u0131nlanmas\u0131 engellenmi\u015f olur. Sonu\u00e7 olarak, GlobalTech, dok\u00fcmantasyon kalitesini \u00f6nemli \u00f6l\u00e7\u00fcde art\u0131rd\u0131, geli\u015ftiricilerin API'yi daha h\u0131zl\u0131 benimsemesini sa\u011flad\u0131 ve destek maliyetlerini d\u00fc\u015f\u00fcrd\u00fc. Bu, statik denetleyicilerin \u00e7ok dilli ve karma\u015f\u0131k projelerde ne kadar kritik olabilece\u011finin m\u00fckemmel bir \u00f6rne\u011fidir.<\/p>\n A\u00e7\u0131k kaynak projeleri, d\u00fcnya genelinden katk\u0131da bulunan geli\u015ftiricilerin ortak \u00e7abalar\u0131yla b\u00fcy\u00fcr. Bu modelin en b\u00fcy\u00fck avantaj\u0131 \u00e7e\u015fitlilik ve topluluk g\u00fcc\u00fc olsa da, beraberinde kalite kontrol zorluklar\u0131n\u0131 da getirir. Binlerce farkl\u0131 ki\u015finin belirli bir projeye kod veya dok\u00fcmantasyon katk\u0131s\u0131 sundu\u011funu hayal edin. Herkesin kendi yaz\u0131m stili, format tercihi ve terminoloji anlay\u0131\u015f\u0131 olabilir. B\u00fcy\u00fck ve pop\u00fcler bir a\u00e7\u0131k kaynak projesi olan \"OpenDevTools\", \u00e7e\u015fitli geli\u015ftirme ara\u00e7lar\u0131 i\u00e7in mod\u00fcller sa\u011fl\u0131yor. Projenin dok\u00fcmantasyonu, hem yeni kullan\u0131c\u0131lara rehberlik etmek hem de katk\u0131da bulunan geli\u015ftiricilerin mod\u00fcllerini nas\u0131l geli\u015ftireceklerini a\u00e7\u0131klamak a\u00e7\u0131s\u0131ndan kritik \u00f6neme sahip. Ancak, farkl\u0131 katk\u0131da bulunanlardan gelen belgeler genellikle tutars\u0131z bi\u00e7imlendirmeye, eksik bilgilere ve farkl\u0131 bir tona sahip oluyordu. Bu durum, dok\u00fcmantasyonun okunabilirli\u011fini azalt\u0131yor ve projenin profesyonel imaj\u0131na zarar veriyordu.<\/p>\n OpenDevTools ekibi, bu sorunu \u00e7\u00f6zmek i\u00e7in markdownlint ve Vale gibi ara\u00e7lar\u0131 birle\u015ftirerek kapsaml\u0131 bir statik dok\u00fcmantasyon denetim sistemi kurdu. \u0130lk olarak, projenin dok\u00fcmantasyon standartlar\u0131n\u0131 belirleyen ayr\u0131nt\u0131l\u0131 bir stil k\u0131lavuzu olu\u015fturdular. Ard\u0131ndan, markdownlint'i kullanarak t\u00fcm Markdown dosyalar\u0131nda tutarl\u0131 ba\u015fl\u0131k seviyeleri, kod blo\u011fu formatlar\u0131 ve liste stilleri gibi bi\u00e7imlendirme kurallar\u0131n\u0131 zorunlu k\u0131ld\u0131lar. Ayr\u0131ca, Vale'i, projenin \u00f6zel terminolojisini (\u00f6rne\u011fin, \"widget\" yerine her zaman \"component\" kullan\u0131lmas\u0131) ve genel yaz\u0131m stilini denetlemek i\u00e7in yap\u0131land\u0131rd\u0131lar. En \u00f6nemlisi, bu denetleyicileri GitHub Actions gibi bir CI\/CD platformuna entegre ettiler. Herhangi bir geli\u015ftirici bir pull request (\u00e7ekme iste\u011fi) a\u00e7t\u0131\u011f\u0131nda, dok\u00fcmantasyon dosyalar\u0131 otomatik olarak bu denetleyiciler taraf\u0131ndan kontrol ediliyor. E\u011fer bir katk\u0131da bulunan\u0131n belgesinde denetleyici kurallar\u0131na uymayan bir durum varsa, CI\/CD boru hatt\u0131 ba\u015far\u0131s\u0131z oluyor ve ilgili sorunlar, pull request yorumlar\u0131 olarak otomatikman rapor ediliyor. Bu sayede, katk\u0131da bulunanlar, de\u011fi\u015fikliklerinin standartlara uygun olmad\u0131\u011f\u0131n\u0131 hemen g\u00f6r\u00fcyor ve gerekli d\u00fczeltmeleri yapabiliyorlar. Bu yakla\u015f\u0131m, OpenDevTools projesinin dok\u00fcmantasyon kalitesini \u00f6nemli \u00f6l\u00e7\u00fcde art\u0131rd\u0131, yeni katk\u0131da bulunanlar\u0131n standartlara h\u0131zl\u0131ca adapte olmas\u0131n\u0131 sa\u011flad\u0131 ve proje y\u00f6neticilerinin manuel inceleme y\u00fck\u00fcn\u00fc azaltt\u0131. A\u00e7\u0131k kaynak projelerinde kaliteyi koruman\u0131n ve s\u00fcrd\u00fcr\u00fclebilir bir geli\u015ftirme ortam\u0131 sa\u011flaman\u0131n anahtar\u0131, otomasyondan ge\u00e7iyor ve statik dok\u00fcmantasyon denetleyicileri bu otomasyonun temel ta\u015flar\u0131ndan biridir.<\/p>\n Statik dok\u00fcmantasyon denetleyicilerinin ger\u00e7ek g\u00fcc\u00fc, sadece lokalde manuel olarak \u00e7al\u0131\u015ft\u0131r\u0131lmalar\u0131yla s\u0131n\u0131rl\u0131 de\u011fildir; bu ara\u00e7lar\u0131n CI\/CD s\u00fcre\u00e7lerine entegrasyonu, dok\u00fcmantasyon kalitesini s\u00fcrekli olarak y\u00fcksek tutman\u0131n en etkili yoludur. Ayr\u0131ca, projeye \u00f6zel ihtiya\u00e7lara g\u00f6re uyarlanabilirlikleri, bu sistemlerin sa\u011flad\u0131\u011f\u0131 faydalar\u0131 maksimize eder.<\/p>\n S\u00fcrekli Entegrasyon (CI) ve S\u00fcrekli Da\u011f\u0131t\u0131m (CD) boru hatlar\u0131, yaz\u0131l\u0131m geli\u015ftirmede otomasyonun kalbidir. Dok\u00fcmantasyon denetleyicilerini bu boru hatlar\u0131na dahil etmek, her kod de\u011fi\u015fikli\u011finde dok\u00fcmantasyonun otomatik olarak denetlenmesini sa\u011flar. Bu, manuel g\u00f6zden ge\u00e7irme ihtiyac\u0131n\u0131 azalt\u0131r, hatalar\u0131n erken a\u015famada tespit edilmesini kolayla\u015ft\u0131r\u0131r ve genel dok\u00fcmantasyon kalitesini garanti alt\u0131na al\u0131r.<\/p>\n \u00d6rne\u011fin, GitHub Actions kullanarak bir Markdown dok\u00fcmantasyon denetimi i\u00e7in basit bir YAML dosyas\u0131 olu\u015ftural\u0131m. Bu \u00f6rnek, her bir push veya pull request olay\u0131nda <\/code><\/p>\n Bu yap\u0131land\u0131rma, projenizin Her projenin dok\u00fcmantasyon ihtiya\u00e7lar\u0131 benzersizdir. Bu nedenle, \u00e7o\u011fu statik dok\u00fcmantasyon denetleyicisi, projenize \u00f6zel kurallar tan\u0131mlama yetene\u011fi sunar. Bu, varsay\u0131lan denetim kurallar\u0131n\u0131n \u00f6tesine ge\u00e7erek, \u015firketinizin veya projenizin terminolojisini, stil k\u0131lavuzunu veya belirli yap\u0131sal gereksinimlerini uygulaman\u0131za olanak tan\u0131r.<\/p>\n \u00d6rne\u011fin, Vale, Python veya JavaScript ile \u00f6zel stiller yazman\u0131za izin verir. Kendi \u00f6zel kelime listenizi ( \u00d6zel bir Vale kural\u0131 \u00f6rne\u011fi ( <\/code><\/p>\n Bu kural, dok\u00fcmantasyonunuzda \"widget\" kelimesinin kullan\u0131m\u0131n\u0131 denetler ve bunun yerine \"component\" kullan\u0131lmas\u0131 gerekti\u011fini \u00f6nerir. Bu t\u00fcr \u00f6zel kurallar, dok\u00fcmantasyonunuzun sadece dilbilgisi a\u00e7\u0131s\u0131ndan do\u011fru olmas\u0131n\u0131 de\u011fil, ayn\u0131 zamanda projenizin \u00f6zel terminolojisi ve stil k\u0131lavuzuyla da uyumlu olmas\u0131n\u0131 sa\u011flar. Geli\u015fmi\u015f bir kullan\u0131m i\u00e7in, RegEx veya karma\u015f\u0131k mant\u0131k i\u00e7eren kurallar yazarak dok\u00fcmantasyonunuzdaki belirli yap\u0131lar\u0131 veya desenleri denetleyebilirsiniz. Bu sayede, statik denetleyiciniz, projenizin dinamik ihtiya\u00e7lar\u0131na tam olarak uyum sa\u011flayabilen g\u00fc\u00e7l\u00fc bir kalite g\u00fcvence arac\u0131 haline gelir.<\/p>\n Statik dok\u00fcmantasyonunuzun kalitesini art\u0131rmak sadece i\u00e7erik do\u011frulu\u011fu ve tutarl\u0131l\u0131\u011f\u0131yla ilgili de\u011fildir; ayn\u0131 zamanda bu dok\u00fcmantasyonun farkl\u0131 cihazlarda, \u00f6zellikle de mobil cihazlarda ne kadar eri\u015filebilir ve okunabilir oldu\u011fuyla da yak\u0131ndan ilgilidir. Geli\u015ftiricilerin ve kullan\u0131c\u0131lar\u0131n b\u00fcy\u00fck bir k\u0131sm\u0131 art\u0131k ak\u0131ll\u0131 telefonlar veya tabletler \u00fczerinden dok\u00fcmantasyona eri\u015fiyor. Bu nedenle, dok\u00fcmantasyonunuzun mobil uyumlu olmas\u0131, kullan\u0131c\u0131 deneyimi a\u00e7\u0131s\u0131ndan kritik \u00f6neme sahiptir.<\/p>\n Bir statik dok\u00fcmantasyon denetleyicisi do\u011frudan mobil uyumlulu\u011fu kontrol etmese de, olu\u015fturdu\u011funuz HTML \u00e7\u0131kt\u0131s\u0131n\u0131n (genellikle Markdown, reStructuredText gibi kaynak dosyalar\u0131ndan derlenir) mobil dostu oldu\u011fundan emin olmak i\u00e7in uygulaman\u0131z gereken stil ve tasar\u0131m prensipleri vard\u0131r. CSS Media Query'leri, bu uyumlulu\u011fu sa\u011flaman\u0131n temel arac\u0131d\u0131r. Bu sorgular sayesinde, ekran boyutuna, \u00e7\u00f6z\u00fcn\u00fcrl\u00fc\u011fe veya cihaz\u0131n y\u00f6n\u00fcne g\u00f6re farkl\u0131 stil kurallar\u0131 uygulayabilirsiniz.<\/p>\n \u0130\u015fte dok\u00fcmantasyon sitenizde mobil uyumlulu\u011fu art\u0131rmak i\u00e7in kullanabilece\u011finiz baz\u0131 temel CSS Media Query \u00f6rnekleri:<\/p>\n \u00c7o\u011fu mobil cihaz i\u00e7in, sayfa geni\u015fli\u011fini k\u00fc\u00e7\u00fcltmek ve yaz\u0131 boyutunu optimize etmek esast\u0131r. Bu, metnin ekrana s\u0131\u011fmas\u0131n\u0131 ve g\u00f6z\u00fc yormamas\u0131n\u0131 sa\u011flar.<\/p>\n <\/code><\/p>\n Dok\u00fcmantasyonda s\u0131k\u00e7a kullan\u0131lan kod bloklar\u0131, mobil ekranlarda genellikle ta\u015fma yapar. <\/code><\/p>\n Geni\u015f tablolar, mobil ekranlarda okunmas\u0131 en zor i\u00e7eriklerden biridir. Tablolar\u0131 duyarl\u0131 hale getirmek i\u00e7in farkl\u0131 yakla\u015f\u0131mlar mevcuttur. En basit y\u00f6ntemlerden biri, tablonun bir kapsay\u0131c\u0131 i\u00e7inde kayd\u0131r\u0131labilir olmas\u0131n\u0131 sa\u011flamakt\u0131r:<\/p>\n <\/code><\/p>\n Geni\u015f bir navigasyon men\u00fcs\u00fc, mobil ekranlarda \u00e7ok yer kaplar. \"Hamburger\" men\u00fcleri veya alt alta s\u0131ralanm\u0131\u015f basit bir liste, mobil cihazlar i\u00e7in daha uygun bir \u00e7\u00f6z\u00fcmd\u00fcr.<\/p>\n <\/code><\/p>\n Bu \u00f6rnekler, dok\u00fcmantasyonunuzu mobil dostu hale getirmek i\u00e7in CSS Media Query'lerinin nas\u0131l kullan\u0131labilece\u011fine dair bir ba\u015flang\u0131\u00e7 noktas\u0131 sunar. Dok\u00fcmantasyon sitenizin \u00f6zel yap\u0131s\u0131na ve kulland\u0131\u011f\u0131n\u0131z statik site olu\u015fturucusuna (\u00f6rne\u011fin, Sphinx, DocFX, Docusaurus) ba\u011fl\u0131 olarak bu stilleri uyarlaman\u0131z gerekebilir. Unutmay\u0131n ki iyi bir mobil deneyim, kullan\u0131c\u0131lar\u0131n dok\u00fcmantasyonunuzu her yerden ve her an rahatl\u0131kla okuyabilmesini sa\u011flar, bu da projenizin eri\u015filebilirli\u011fini ve benimsenmesini do\u011frudan etkiler.<\/p>\n Statik dok\u00fcmantasyon denetleyicileri, modern yaz\u0131l\u0131m geli\u015ftirme s\u00fcre\u00e7lerinin vazge\u00e7ilmez bir par\u00e7as\u0131 haline gelmi\u015ftir. Bu makale boyunca, dok\u00fcmantasyonun neden s\u0131k\u00e7a g\u00f6z ard\u0131 edildi\u011fini ve kalitesizli\u011finin getirdi\u011fi sorunlar\u0131 ele ald\u0131k. Statik denetleyicilerin ne oldu\u011funu, nas\u0131l \u00e7al\u0131\u015ft\u0131klar\u0131n\u0131 ve Vale ile markdownlint gibi pop\u00fcler ara\u00e7lar \u00fczerinden ad\u0131m ad\u0131m nas\u0131l kurulup yap\u0131land\u0131r\u0131labilece\u011fini \u00f6\u011frendik. Ayr\u0131ca, \u00e7ok dilli API dok\u00fcmantasyonlar\u0131nda tutarl\u0131l\u0131\u011f\u0131 sa\u011flamaktan a\u00e7\u0131k kaynak projelerinde kaliteyi korumaya kadar, ger\u00e7ek d\u00fcnya senaryolar\u0131nda bu ara\u00e7lar\u0131n g\u00fcc\u00fcn\u00fc ve sa\u011flad\u0131\u011f\u0131 faydalar\u0131 inceledik. CI\/CD s\u00fcre\u00e7lerine entegrasyonun ve \u00f6zel kurallar tan\u0131mlaman\u0131n, denetleyicilerden maksimum verim alman\u0131n anahtar\u0131 oldu\u011funu g\u00f6rd\u00fck. Son olarak, mobil uyumlu dok\u00fcmantasyonun \u00f6nemi ve CSS Media Query'leri ile nas\u0131l optimize edilebilece\u011fi konular\u0131na de\u011findik.<\/p>\n Sonu\u00e7 olarak, statik dok\u00fcmantasyon denetleyicileri, teknik borcu azaltman\u0131n, geli\u015ftirici verimlili\u011fini art\u0131rman\u0131n ve projenizin s\u00fcrd\u00fcr\u00fclebilirli\u011fini sa\u011flaman\u0131n etkili bir yolunu sunar. Dok\u00fcmantasyonun sadece bir \"ek i\u015f\" de\u011fil, yaz\u0131l\u0131m\u0131n\u0131z\u0131n kritik bir bile\u015feni oldu\u011funu kabul ederek, bu ara\u00e7lar\u0131 geli\u015ftirme s\u00fcre\u00e7lerinize entegre etmek, uzun vadede size zaman, para ve itibar kazand\u0131racakt\u0131r. Dok\u00fcmantasyonunuzu otomatikle\u015ftirilmi\u015f, tutarl\u0131 ve eri\u015filebilir hale getirerek, projenizin gelece\u011fini g\u00fcvence alt\u0131na alm\u0131\u015f olursunuz.<\/p>\n Evet, \u00f6zellikle orta ve b\u00fcy\u00fck \u00f6l\u00e7ekli projelerde veya birden fazla ki\u015finin katk\u0131da bulundu\u011fu durumlarda kesinlikle gereklidir. Manuel denetimler zaman al\u0131c\u0131, hataya a\u00e7\u0131k ve tutars\u0131z sonu\u00e7lar do\u011furabilir. Otomatik denetleyiciler, bu sorunlar\u0131 ortadan kald\u0131rarak dok\u00fcmantasyon kalitesini art\u0131r\u0131r, geli\u015ftirici verimlili\u011fini y\u00fckseltir ve teknik borcu azalt\u0131r.<\/p>\n \u00c7o\u011fu statik dok\u00fcmantasyon denetleyicisi, Markdown, reStructuredText, AsciiDoc gibi pop\u00fcler hafif bi\u00e7imlendirme dillerini destekler. Baz\u0131 ara\u00e7lar (\u00f6rne\u011fin Vale), HTML ve do\u011fal dil metinleri \u00fczerinde de geli\u015fmi\u015f dilbilgisi ve stil denetimleri yapabilir. Her arac\u0131n destekledi\u011fi formatlar farkl\u0131l\u0131k g\u00f6sterebilir, bu nedenle se\u00e7ti\u011finiz arac\u0131n ihtiya\u00e7lar\u0131n\u0131z\u0131 kar\u015f\u0131lad\u0131\u011f\u0131ndan emin olun.<\/p>\n Statik denetleyiciler, dilbilgisi ve yaz\u0131m hatalar\u0131n\u0131 tespit edebilir ve size \u00f6neriler sunabilirler. Ancak, otomatik olarak d\u00fczeltme yetenekleri s\u0131n\u0131rl\u0131d\u0131r. Genellikle size hatan\u0131n konumunu ve ne t\u00fcr bir hata oldu\u011funu belirtirler, d\u00fczeltme i\u015flemini ise manuel olarak yapman\u0131z beklenir. Bu sayede, i\u00e7eri\u011fin anlam\u0131n\u0131 de\u011fi\u015ftirebilecek otomatik d\u00fczeltmelerin \u00f6n\u00fcne ge\u00e7ilir.<\/p>\n \u00d6zel kurallar tan\u0131mlaman\u0131n karma\u015f\u0131kl\u0131\u011f\u0131, kulland\u0131\u011f\u0131n\u0131z araca ve kurallar\u0131n kendisinin karma\u015f\u0131kl\u0131\u011f\u0131na ba\u011fl\u0131d\u0131r. Basit kelime veya terim kontrol\u00fc gibi kurallar genellikle kolayca yap\u0131land\u0131r\u0131labilir. Daha karma\u015f\u0131k desen e\u015fle\u015ftirme veya ba\u011flama duyarl\u0131 kontroller i\u00e7in Regex bilgisi veya arac\u0131n kendi kural yaz\u0131m dilini \u00f6\u011frenmeniz gerekebilir. Ancak \u00e7o\u011fu ara\u00e7, iyi dok\u00fcmante edilmi\u015f ve ba\u015flang\u0131\u00e7 seviyesinde bile \u00f6zel kurallar olu\u015fturmay\u0131 m\u00fcmk\u00fcn k\u0131lan bir yap\u0131 sunar.<\/p>\n Dok\u00fcmantasyon denetleyicilerini CI\/CD boru hatt\u0131na entegre etmek, genellikle birka\u00e7 ad\u0131mdan olu\u015fur: projenizin .md<\/code>, .rst<\/code> veya .html<\/code> uzant\u0131l\u0131 dosyalar olabilir. Tarama s\u0131ras\u0131nda, denetleyici \u00f6nceden tan\u0131mlanm\u0131\u015f bir dizi kural\u0131 bu dosyalara uygular. Bu kurallar, yaz\u0131m ve dilbilgisi hatalar\u0131n\u0131 tespit etmekten, belirli anahtar kelimelerin kullan\u0131m\u0131n\u0131 zorunlu k\u0131lmaya veya yasaklamaya, tutars\u0131z ba\u015fl\u0131k seviyelerini bulmaya, bozuk ba\u011flant\u0131lar\u0131 belirlemeye ve hatta resimlerin alternatif metinlerini kontrol etmeye kadar geni\u015f bir yelpazeyi kapsayabilir. \u00d6rne\u011fin, bir Markdown denetleyicisi, ba\u015fl\u0131klar aras\u0131nda bo\u015f sat\u0131r b\u0131rak\u0131lmas\u0131 gerekti\u011fini veya bir kod blo\u011funun dilinin belirtilmesi gerekti\u011fini zorunlu k\u0131labilir. Do\u011fal dil denetleyicileri ise, belirli terimlerin do\u011fru kullan\u0131m\u0131n\u0131, c\u00fcmlenin aktif mi pasif mi oldu\u011funu veya belirli bir tonun korunup korunmad\u0131\u011f\u0131n\u0131 kontrol edebilir.<\/p>\nAd\u0131m Ad\u0131m Bir Dok\u00fcmantasyon Denetleyicisi Nas\u0131l Kurulur ve Yap\u0131land\u0131r\u0131l\u0131r?<\/h2>\n
Pop\u00fcler Ara\u00e7lar: Vale ve markdownlint ile \u0130lk Ad\u0131mlar<\/h3>\n
Vale Kurulumu ve Yap\u0131land\u0131rmas\u0131<\/h4>\n
\n
brew install vale<\/pre>\nscoop install vale<\/pre>\nwget https:\/\/github.com\/errata-ai\/vale\/releases\/latest\/download\/vale_2.22.1_Linux_64-bit.deb -O vale.deb && sudo dpkg -i vale.deb<\/pre>\n.vale.ini<\/code> dosyas\u0131 olu\u015fturman\u0131z gerekir. Bu dosya, Vale'in hangi stilleri (\u00f6rne\u011fin, Microsoft Writing Style Guide, Google Developer Documentation Style Guide) kullanaca\u011f\u0131n\u0131 ve hangi klas\u00f6rleri denetleyece\u011fini belirtir. \u0130\u015fte basit bir \u00f6rnek:<\/p>\n\nStylesPath = styles\nMinAlertLevel = suggestion\nIgnoredScopes = code\n\n[*.md]\nBasedOnStyles = Vale, Google\n<\/pre>\nstyles<\/code> klas\u00f6r\u00fcndeki \u00f6zel stilleri kullan\u0131r, uyar\u0131 seviyesini \"suggestion\" olarak ayarlar, kod bloklar\u0131n\u0131 denetlemez ve Markdown dosyalar\u0131 i\u00e7in Vale'in kendi varsay\u0131lan stilini ve Google stilini kullan\u0131r. Ayr\u0131ca, styles<\/code> klas\u00f6r\u00fcn\u00fcze farkl\u0131 stiller ekleyerek Vale'in yeteneklerini geni\u015fletebilirsiniz. \u00d6rne\u011fin, Google stilini eklemek i\u00e7in: <\/p>\nvale sync<\/pre>\nmarkdownlint Kurulumu ve Yap\u0131land\u0131rmas\u0131<\/h4>\n
\nnpm install -g markdownlint-cli\n<\/pre>\n.markdownlint.jsonc<\/code> dosyas\u0131 olu\u015fturabilirsiniz. Bu dosya, hangi kurallar\u0131n etkin veya devre d\u0131\u015f\u0131 b\u0131rak\u0131laca\u011f\u0131n\u0131 ve baz\u0131 kurallar\u0131n \u00f6zel parametrelerini belirler. \u0130\u015fte bir \u00f6rnek:<\/p>\n\n{\n \"default\": true,\n \"MD001\": false, \/\/ Ba\u015fl\u0131k hiyerar\u015fisi\n \"MD003\": { \"style\": \"atx\" }, \/\/ Ba\u015fl\u0131k stili\n \"MD013\": { \"line_length\": 120, \"code_blocks\": false, \"tables\": false }, \/\/ Sat\u0131r uzunlu\u011fu\n \"MD029\": { \"style\": \"ordered\" } \/\/ Numaral\u0131 liste stili\n}\n<\/pre>\n\u00d6rnek Bir Belge \u00dczerinde Denetleme \u00c7al\u0131\u015ft\u0131rmak<\/h3>\n
ornek-belge.md<\/code> ad\u0131nda bir dosya olu\u015ftural\u0131m:<\/p>\n\n# Ba\u015fl\u0131k 1\nBu, ilk paragraft\u0131r. Biraz metin.\nBu bir kal\u0131n<\/strong> metin.\n\nBa\u015fl\u0131k 2<\/strong>\n\nBir liste:\n* Madde 1\n* Madde 2\n\nconsole.log(\"Bu bir kod blo\u011fu.\");<\/pre>\n
\n<\/code><\/p>\n\n
vale ornek-belge.md<\/pre>\nmarkdownlint ornek-belge.md<\/pre>\nGer\u00e7ek D\u00fcnya Senaryolar\u0131: B\u00fcy\u00fck Projelerde Statik Denetleyicilerin G\u00fcc\u00fc<\/h2>\n
Senaryo 1: \u00c7ok Dilli Bir API Dok\u00fcmantasyonunu S\u00fcrekli Do\u011frulama<\/h3>\n
Senaryo 2: A\u00e7\u0131k Kaynak Topluluklar\u0131nda Kaliteyi Korumak<\/h3>\n
Performans ve Entegrasyon: Denetleyicinizden Maksimum Verim Al\u0131n<\/h2>\n
CI\/CD S\u00fcre\u00e7lerine Entegrasyon: Otomatik Denetimler<\/h3>\n
markdownlint-cli<\/code> arac\u0131n\u0131 \u00e7al\u0131\u015ft\u0131racakt\u0131r:<\/p>\n\nname: Documentation Linting\n\non:\n push:\n branches:\n - main\n pull_request:\n branches:\n - main\n\njobs:\n lint-docs:\n runs-on: ubuntu-latest\n steps:\n - name: Check out repository\n uses: actions\/checkout@v3\n\n - name: Set up Node.js\n uses: actions\/setup-node@v3\n with:\n node-version: '16'\n\n - name: Install markdownlint-cli\n run: npm install -g markdownlint-cli\n\n - name: Run markdownlint\n run: markdownlint --config .markdownlint.jsonc \"docs\/**\/*.md\"\n continue-on-error: false # Hata durumunda i\u015flemi durdur\n\n<\/pre>\ndocs\/<\/code> klas\u00f6r\u00fcndeki t\u00fcm Markdown dosyalar\u0131n\u0131, .markdownlint.jsonc<\/code> dosyas\u0131ndaki kurallara g\u00f6re denetleyecektir. E\u011fer herhangi bir lint hatas\u0131 bulunursa, CI boru hatt\u0131 ba\u015far\u0131s\u0131z olacak ve bu da geli\u015ftiricilerin hatay\u0131 d\u00fczeltmeden kodlar\u0131n\u0131 birle\u015ftirmesini engelleyecektir. Benzer \u015fekilde, Vale veya ba\u015fka bir denetleyiciyi de bu ad\u0131mlara entegre edebilirsiniz. Bu otomatik denetimler, \u00f6zellikle b\u00fcy\u00fck ekiplerde ve s\u0131k g\u00fcncellemelerin oldu\u011fu projelerde paha bi\u00e7ilmezdir.<\/p>\n\u00d6zel Kurallar Tan\u0131mlama ve Geni\u015fletilebilirlik<\/h3>\n
vocab.txt<\/code>) veya k\u0131saltma listenizi (acronyms.txt<\/code>) ekleyerek, projenize \u00f6zel terimlerin do\u011fru kullan\u0131m\u0131n\u0131 veya yanl\u0131\u015f yaz\u0131mlar\u0131n\u0131 kontrol edebilirsiniz. Veya bir JavaScript linter'i gibi, Vale i\u00e7in bir \"eklenti\" yazarak, belirli bir HTML yap\u0131s\u0131n\u0131n veya Markdown syntax'\u0131n\u0131n do\u011fru kullan\u0131l\u0131p kullan\u0131lmad\u0131\u011f\u0131n\u0131 kontrol edebilirsiniz. Bu esneklik, statik denetleyicilerin projenizin dok\u00fcmantasyon kalitesini en \u00fcst d\u00fczeye \u00e7\u0131karmas\u0131 i\u00e7in kritik \u00f6neme sahiptir.<\/p>\nstyles\/MyProject\/Terms.yml<\/code> i\u00e7inde):<\/p>\n\n# Yanl\u0131\u015f kullan\u0131mlar\u0131 denetler\nextends: existence\nmessage: \"L\u00fctfen 'widget' yerine 'component' kullan\u0131n.\"\nscope: raw\nignorecase: true\ntokens:\n - widget\n<\/pre>\nMobil Kullan\u0131c\u0131lar \u0130\u00e7in Dok\u00fcmantasyon Optimizasyonu: CSS Media Query \u00d6rnekleri<\/h2>\n
1. Genel D\u00fczen ve Okunabilirlik \u0130\u00e7in Temel Media Query<\/h4>\n
\n@media (max-width: 768px) {\n body {\n font-size: 16px; \/* Mobil cihazlar i\u00e7in temel yaz\u0131 boyutunu b\u00fcy\u00fct *\/\n line-height: 1.6; \/* Sat\u0131r aral\u0131\u011f\u0131n\u0131 art\u0131rarak okunabilirli\u011fi iyile\u015ftir *\/\n margin: 0 15px; \/* Kenarlardan bo\u015fluk b\u0131rakarak i\u00e7eri\u011fi s\u0131k\u0131\u015ft\u0131rmay\u0131 \u00f6nle *\/\n }\n\n h1, h2, h3 {\n font-size: 1.8em; \/* Ba\u015fl\u0131k boyutlar\u0131n\u0131 mobil i\u00e7in ayarla *\/\n word-wrap: break-word; \/* Uzun kelimelerin ta\u015fmas\u0131n\u0131 engelle *\/\n }\n\n img {\n max-width: 100%; \/* Resimlerin ekran geni\u015fli\u011fini a\u015fmas\u0131n\u0131 engelle *\/\n height: auto;\n }\n}\n<\/pre>\n2. Kod Bloklar\u0131 \u0130\u00e7in Kayd\u0131r\u0131labilir Alan<\/h4>\n
overflow-x: auto;<\/code> \u00f6zelli\u011fi, kod blo\u011funun yatay olarak kayd\u0131r\u0131labilir olmas\u0131n\u0131 sa\u011flayarak bu sorunu \u00e7\u00f6zer.<\/p>\n\n@media (max-width: 768px) {\n pre, code {\n white-space: pre-wrap; \/* Metin ta\u015fmas\u0131n\u0131 \u00f6nle *\/\n word-wrap: break-word; \/* Kelime baz\u0131nda sat\u0131r atlat *\/\n overflow-x: auto; \/* Yatay kayd\u0131rma \u00e7ubu\u011fu ekle *\/\n padding: 10px;\n }\n}\n<\/pre>\n3. Tablolar\u0131n Duyarl\u0131l\u0131\u011f\u0131<\/h4>\n
\n@media (max-width: 768px) {\n table {\n width: 100%; \/* Tabloyu kapsay\u0131c\u0131ya s\u0131\u011fd\u0131r *\/\n display: block; \/* Blo\u011fa d\u00f6n\u00fc\u015ft\u00fcr *\/\n overflow-x: auto; \/* Yatay kayd\u0131rma \u00e7ubu\u011fu ekle *\/\n white-space: nowrap; \/* \u0130\u00e7eri\u011fin sar\u0131lmas\u0131n\u0131 engelle *\/\n }\n\n \/* Alternatif olarak, tablo ba\u015fl\u0131klar\u0131n\u0131 g\u00f6sterip geri kalan\u0131n\u0131 gizleyebilir\n veya s\u00fctunlar\u0131 y\u0131\u011f\u0131n halinde g\u00f6sterebilirsiniz. *\/\n}\n<\/pre>\n4. Navigasyon Men\u00fclerinin Optimize Edilmesi<\/h4>\n
\n@media (max-width: 768px) {\n .sidebar { \/* Yan men\u00fc (\u00f6rne\u011fin DocFX'te sol men\u00fc) *\/\n display: none; \/* Mobil cihazlarda yan men\u00fcy\u00fc varsay\u0131lan olarak gizle *\/\n }\n\n .main-content {\n width: 100%; \/* Ana i\u00e7eri\u011fin tam geni\u015fli\u011fi kullanmas\u0131n\u0131 sa\u011fla *\/\n padding: 10px;\n }\n\n \/* Hamburger men\u00fc ikonu ve a\u00e7\u0131l\u0131r kapan\u0131r men\u00fc i\u00e7in JS ile birlikte *\/\n .mobile-nav-toggle {\n display: block; \/* Mobil men\u00fc ikonunu g\u00f6ster *\/\n }\n\n .mobile-nav-menu {\n display: none; \/* Mobil men\u00fcy\u00fc varsay\u0131lan olarak gizle *\/\n \/* Men\u00fc a\u00e7\u0131ld\u0131\u011f\u0131nda display: block veya flex olarak ayarlan\u0131r *\/\n }\n}\n<\/pre>\nDok\u00fcmantasyonunuzu Gelece\u011fe Ta\u015f\u0131y\u0131n: \u00d6zet ve S\u0131k\u00e7a Sorulan Sorular<\/h2>\n
S\u0131k\u00e7a Sorulan Sorular (SSS)<\/h3>\n
1. Statik dok\u00fcmantasyon denetleyicisi kullanmak ger\u00e7ekten gerekli mi?<\/h4>\n
2. Hangi dok\u00fcmantasyon formatlar\u0131 desteklenir?<\/h4>\n
3. Statik denetleyiciler dilbilgisi ve yaz\u0131m hatalar\u0131n\u0131 d\u00fczeltebilir mi?<\/h4>\n
4. \u00d6zel kurallar tan\u0131mlamak karma\u015f\u0131k m\u0131d\u0131r?<\/h4>\n
5. Dok\u00fcmantasyon denetleyicilerini CI\/CD boru hatt\u0131ma nas\u0131l entegre edebilirim?<\/h4>\n
.github\/workflows<\/code> (GitHub Actions), .gitlab-ci.yml<\/code> (GitLab CI) gibi CI\/CD yap\u0131land\u0131rma dosyas\u0131na bir ad\u0131m eklemeniz gerekir. Bu ad\u0131m, gerekli ba\u011f\u0131ml\u0131l\u0131klar\u0131 y\u00fckler (\u00f6rn. npm install -g markdownlint-cli<\/code>) ve ard\u0131ndan denetleyiciyi (\u00f6rn. markdownlint --config .markdownlint.jsonc \"docs\/**\/*.md\"<\/code>) \u00e7al\u0131\u015ft\u0131r\u0131r. Bir hata bulunursa, CI i\u015fi ba\u015far\u0131s\u0131z olur, bu da hatal\u0131 dok\u00fcmantasyonun ana dalda birle\u015fmesini engeller. \u00d6rnekleri yukar\u0131daki \"CI\/CD S\u00fcre\u00e7lerine Entegrasyon\" b\u00f6l\u00fcm\u00fcnde bulabilirsiniz.<\/p>\n","protected":false},"excerpt":{"rendered":"Proje dok\u00fcmantasyonu, yaz\u0131l\u0131m geli\u015ftirme s\u00fcrecinin ayr\u0131lmaz bir par\u00e7as\u0131d\u0131r ancak s\u0131kl\u0131kla g\u00f6z ard\u0131 edilir veya g\u00fcncelli\u011fini yitirir. Peki, ya…","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"csco_page_header_type":"","csco_page_load_nextpost":"","csco_page_subscribe_form":"","csco_page_contact_form":"","footnotes":""},"categories":[1],"tags":[],"class_list":{"0":"post-34052","1":"post","2":"type-post","3":"status-publish","4":"format-standard","6":"category-genel","7":"cs-entry","8":"cs-video-wrap"},"yoast_head":"\n