ãã®ãã¼ðä»ãé ã¶ã³ã¨ã³ã¸ã㢠@shinoyu 座å³ã®éã¯äººçæ¥ç¥ãããæ³äººãã£ã¦ããªã«ãã®ããã°ã©ã20å¹´ç+è¦ç¿ããã¼ãã³ãã¼ å ¼è²ç°ã®ã¬ã«ãã§åããªãã§ãã / ã¿ã / ITãVç³» ãããªã£ã¿ã®äºº / ãã©ãã¼ã¯åå忥ã®ã¿ / éµã¢ã«ããã®ãã©ãã¼ã¯æç¾©ã«ããããã㯠ãã®ãã¼ðä»ãé ã¶ã³ã¨ã³ã¸ã㢠@shinoyu ãã詳細è¨è¨æ¸æ¸ãã®ãã ã( ̄・Ï・ ̄) ç´°ãããã°ç´°ããã»ã©ä»æ§å¤ãã£ãæã®å¤æ´ãçå¢ãã¦ã¡ã³ãã³ã¹ãçä¸ããããããããã¹ãã³ã¹ãã¯ãããããªãã å¿ è¦ãªã®ã¯å®æã«å¿ è¦è¦ä»¶ãã¾ã¨ãããããã®ããããå ã«åãå ¥ãè©¦é¨æ¸ãã¤ãããããããã¯ãªã¢ããã°ã©ãä½ã£ã¦ãããæ§ããããã æ¹ä¿®ã³ã¹ããä¸ããããã®è¨è¨ã«ãªã£ã¦ããã¨ã¯åæã ãã©ãã ã ãã©ã詳細è¨è¨æ¸ãå¿ è¦ã¨ãªãç¾å ´ã¯ãã®è¨è¨ãããã¨ã¯ã§ããªããã ã£ã¦ããã§ãã¦ãã詳細è¨è¨æ¸ãããªãããã§â¦ 2024-0
ä½ã決å®ããäºå®ã¯å®è£ ãè¦åã®å½¢ã§æ®ã£ã¦ãããã®ã®ã決å®ã¾ã§ã®çµç·¯ããã¼ã ã¡ã³ãã¼ãè¦ãã¦ããªãââã ãã®è¨äºã§ã¯ãããããçµç¹ãè¨æ¶åªå¤±ã«ãªããã¨ã«ã©ã対å¦ãã¦ããã°ããããNTT Comã®æè¡é¡§åã§ããåç¾½é¾å¤ªé (@ryuzee) ããã«ãµãã£ã¨ç¸è«ãã¦ã¿ããä¸ç¬ã§çªç ´å£ãè¦ã¤ãã£ãï¼è©±ã«å¥¥è¡ããåºã話ãå ±æãã¾ãã ç®æ¬¡ ç®æ¬¡ 軽ãèªå·±ç´¹ä» äºã®çºç«¯ ryuzeeããã®æ²¹ã»ã¼ã« å®éã«èãã¦ã¿ã æ°ããªãæ¦å¿µï¼ADR ADRã®å®è·µï¼ãã®1 ä½ãæ¸ãã ADRã®å®è·µï¼ãã®2 ã©ãã«æ¸ãã ADRã®å®è·µï¼ãã®3 ã©ãæ¸ãã ç¸è«ãåãã¦è©¦ãã«æ¸ãã¦ã¿ãADR ã¾ã¨ã 軽ãèªå·±ç´¹ä» ã¤ããã¼ã·ã§ã³ã»ã³ã¿ã¼ã®å°æ (@ppyv) ã§ãã éçºã»æ¤è¨¼ç¨PCã®éçºã«ä¸æ®µè½ã¤ããå¾ã社ä¼äººå¦çã¨ãã¦ãã£ã·ã2å¹´éå¦ç¿ãç©ãã§ãã¾ããã ãã¾ã¯ã¤ããã¼ã·ã§ã³ã»ã³ã¿ã¼ã§åã社å¡ã®ã¿ãªããã«ãããã
ããªãã«ã¨ã£ã¦éè¦ãªãããã¯ãååã®ææ°æ å ±ãå ¥æãã¾ãããææ°ã®æ´å¯ã¨ãã¬ã³ãã«é¢ããææ°æ å ±ãå³åº§ã«åãåãã¾ãããã ç¶ç¶çãªå¦ç¿ã®ããã«ãç¡æã®ãªã½ã¼ã¹ã«æè»½ã«ã¢ã¯ã»ã¹ãã¾ãããããããã¯ããã©ã³ã¹ã¯ãªããä»ãåç»ãããã³ãã¬ã¼ãã³ã°ææã è¨äºãä¿åãã¦ããã¤ã§ãèªããã¨ãã§ãã¾ãè¨äºãããã¯ãã¼ã¯ãã¦ãæºåãã§ããããã¤ã§ãèªãã¾ãã
èªèº«ã®ãã©ã¤ãªãªãã£ã«ããã¾ãããããã¤ãã Markdownã§å¹ åºãåå©ç¨æ§ãå©ãããããé·æçã«ä¸å¯§ã«ç管çããã èªåèªèº«ã®æä½æ§ãæããããã¨ãè¦ãç® ä¿ç¶æè»½ã«ãçæçã«ãOnlineã§ãã¤ã§ãã©ãã§ã ããããã¨ããè¦ç¹ã§èããã¨è¯ãã®ããªã¨æãã並ã¹ã¦ã¿ã¾ããã 1. é·æçã«: Markdownã§å¹ åºãåå©ç¨æ§ãå©ãããããä¸å¯§ã«ç管çããããªã Markdownã§æããã¨ã®ã¡ãªããã¯åå©ç¨æ§ã å°æ¥çã«è¿½è¨ã»ç·¨éãèªå以å¤ã®èª°ããæãå ¥ããå¯è½æ§ãé«ãã ç¾å¨ã®ããã¥ã¡ã³ãã ãã§ãªãå¤ç¨®èª¬æè³æãåªä½ã«è»¢ç¨ããå¯è½æ§ãããã ...ã¨ããç¹ã§å·®å管çãããããªãã以ä¸ã VSCodeã§PlantUMLãMermaid ä¸è¨åèã§ä»¥ä¸ã Alt+D ã§ãã¬ãã¥ã¼èµ·åã Ctrl + Shift + P ã§ã³ãã³ããã¬ãããèµ·åããåºåã png, svg, eps, pdf
ããªãã«ã¨ã£ã¦éè¦ãªãããã¯ãååã®ææ°æ å ±ãå ¥æãã¾ãããææ°ã®æ´å¯ã¨ãã¬ã³ãã«é¢ããææ°æ å ±ãå³åº§ã«åãåãã¾ãããã ç¶ç¶çãªå¦ç¿ã®ããã«ãç¡æã®ãªã½ã¼ã¹ã«æè»½ã«ã¢ã¯ã»ã¹ãã¾ãããããããã¯ããã©ã³ã¹ã¯ãªããä»ãåç»ãããã³ãã¬ã¼ãã³ã°ææã è¨äºãä¿åãã¦ããã¤ã§ãèªããã¨ãã§ãã¾ãè¨äºãããã¯ãã¼ã¯ãã¦ãæºåãã§ããããã¤ã§ãèªãã¾ãã
ããªãã«ã¨ã£ã¦éè¦ãªãããã¯ãååã®ææ°æ å ±ãå ¥æãã¾ãããææ°ã®æ´å¯ã¨ãã¬ã³ãã«é¢ããææ°æ å ±ãå³åº§ã«åãåãã¾ãããã ç¶ç¶çãªå¦ç¿ã®ããã«ãç¡æã®ãªã½ã¼ã¹ã«æè»½ã«ã¢ã¯ã»ã¹ãã¾ãããããããã¯ããã©ã³ã¹ã¯ãªããä»ãåç»ãããã³ãã¬ã¼ãã³ã°ææã è¨äºãä¿åãã¦ããã¤ã§ãèªããã¨ãã§ãã¾ãè¨äºãããã¯ãã¼ã¯ãã¦ãæºåãã§ããããã¤ã§ãèªãã¾ãã
How to document software architecture â this is a question you can consider in two ways. Sure, there are some general best practices that you should always follow. Other than that, however, there are various approaches that work better depending on the complexity and type of your software project. In this article, Iâm going to show software documentation the way itâs done at The Software House. In
ããªãã«ã¨ã£ã¦éè¦ãªãããã¯ãååã®ææ°æ å ±ãå ¥æãã¾ãããææ°ã®æ´å¯ã¨ãã¬ã³ãã«é¢ããææ°æ å ±ãå³åº§ã«åãåãã¾ãããã ç¶ç¶çãªå¦ç¿ã®ããã«ãç¡æã®ãªã½ã¼ã¹ã«æè»½ã«ã¢ã¯ã»ã¹ãã¾ãããããããã¯ããã©ã³ã¹ã¯ãªããä»ãåç»ãããã³ãã¬ã¼ãã³ã°ææã è¨äºãä¿åãã¦ããã¤ã§ãèªããã¨ãã§ãã¾ãè¨äºãããã¯ãã¼ã¯ãã¦ãæºåãã§ããããã¤ã§ãèªãã¾ãã
ããã«ã¡ã¯ä¸¸å±±@h13i32maruã§ããã·ã¹ãã å ¨ä½ãç°¡åãªå³ã¨ããã¹ãã§ã¾ã¨ãããARCHITECTURE.mdãã¨ãããã®ãæè¿ç¥ãã¾ãããããã¯è¯ãããã¨æããJasperã®ARCHITECTURE.mdãæ¸ãã¦ã¿ã¾ããã jasperapp/jasper/ARCHITECTURE.md ARCHITECTURE.mdèªä½ã®ç®çã¯ãããã¸ã§ã¯ãã¸ã®æ°è¦åå è ãå ¨ä½åã®ææ¡ãå¹ççã«è¡ããããã«ãããã¨ããæãã§ããæ¸ãæ¹ã®æéãæ³¨æç¹ãªã©ã¯èæ¡è ã«ããè¨äºãè¦ã¦ãããã®ãããããã§ããã¾ãè¯ããµã³ãã«ã¨ãã¦rust-analyzerã¨ããOSSã®ARCHITECTURE.mdãç´¹ä»ããã¦ãã¾ãã https://matklad.github.io//2021/02/06/ARCHITECTURE.md.html https://github.com/rust-analyzer/ru
ãªã¼ãã³ã½ã¼ã¹ããã¯ããã¸ã¼ãä¸å¿ã¨ããã³ãã¥ããã£ã®ç¶æãçºå±ãæ¯æ´ããçµç¹ãOpen Collectiveãã¯ãWebæè¡ã®ããã¥ã¡ã³ãåãé·æçã«æ¯æ´ããåãçµã¿ã¨ãã¦ãOpen Web Docsããçºè¡¨ãã¾ããã Open Web Docsã¯ããã«æ¢åã®ã³ãã¥ããã£ã«ããããã¥ã¡ã³ããç¹ã«Mozillaã®MDNãã¾ãã¯åªå çã«æ¯æ´ããã¨ãã¦ãã¾ãã Weâre happy and proud to announce Open Web Docs, to support a community of technical writers around creation and long-term maintenance of web platform technology documentation that is open and inclusive for all.https://t
Kubernetesã¯K8sã¨ãã¦ãç¥ããã¦ããããããã¤ãã¹ã±ã¼ãªã³ã°ãèªååããããã³ã³ããåãããã¢ããªã±ã¼ã·ã§ã³ã管çãããããããã®ããªã¼ãã³ã½ã¼ã¹ã®ã·ã¹ãã ã§ãã 管çãæ¤åºã容æã«ãããããã¢ããªã±ã¼ã·ã§ã³ãè«ççãªåä½ã«åå²ããã³ã³ãããã°ã«ã¼ãã³ã°ãã¾ããKubernetesã¯Googleã§ã®15å¹´ã«ãããçµé¨ãåºã«æ§ç¯ããã¦ãããã³ãã¥ããã£ã®ã¢ã¤ãã£ã¢ãæ £ç¿ã¨ã®æåã®çµã¿åãããåã£ã¦ãã¾ãã ææè¦æ¨¡ã®ã¹ã±ã¼ãªã³ã°Googleãé±ã«ä½ååãã®ã³ã³ãããå®è¡ãããã¨ãå¯è½ã¨ãã¦ããã®ã¨åãååã«æ²¿ã£ã¦ãã¶ã¤ã³ããã¦ãããããKubernetesã¯éç¨ãã¼ã ã®äººæ°ãå¢ãããã«è¦æ¨¡ãæ¡å¤§ãããã¨ãã§ãã¾ãã
AWSã®å種ãµã¼ãã¹ãSDKã®ããã¥ã¡ã³ãããªã¼ãã³ã½ã¼ã¹ã¨ãã¦GitHubã«å ¬éã誰ã§ãã³ã³ããªãã¥ã¼ããåå©ç¨ãå¯è½ã« Today we are adding over 138 additional developer and user guides to the organization, and we are looking forward to receiving your requests. You can fix bugs, improve code samples (or submit new ones), add detail, and rewrite sentences and paragraphs in the interest of accuracy or clarity. 仿¥ãç§ãã¡ã¯138以ä¸ã®ãããããã¼ã¬ã¤ãã¨ã¦ã¼ã¶ã¼ã¬ã¤ãã追å ããã¿ãªããã®è¦æãå¿å¾ ã¡
ããªãã«ã¨ã£ã¦éè¦ãªãããã¯ãååã®ææ°æ å ±ãå ¥æãã¾ãããææ°ã®æ´å¯ã¨ãã¬ã³ãã«é¢ããææ°æ å ±ãå³åº§ã«åãåãã¾ãããã ç¶ç¶çãªå¦ç¿ã®ããã«ãç¡æã®ãªã½ã¼ã¹ã«æè»½ã«ã¢ã¯ã»ã¹ãã¾ãããããããã¯ããã©ã³ã¹ã¯ãªããä»ãåç»ãããã³ãã¬ã¼ãã³ã°ææã è¨äºãä¿åãã¦ããã¤ã§ãèªããã¨ãã§ãã¾ãè¨äºãããã¯ãã¼ã¯ãã¦ãæºåãã§ããããã¤ã§ãèªãã¾ãã
ã¯ããã« ããã«ã¡ã¯æ¤æ¨åæ¨¹ï¼ ä¸è¶å¦é«ãªãã£ã¹ã§ããæ¬æ¥ã¯ç§ããã10å¹´ãããæèãã¦ããéç¨æé æ¸ãæ¸ãã¨ãã®ãã¤ã³ãã«ã¤ãã¦ã¾ã¨ãã¦ã¿ã¾ããã 対象èªè éçºã»æ§ç¯ããã·ã¹ãã ãå¥ã®äººã«å¼ãç¶ãäºå®ã®ãã人 ä»ã®äººãä½ã£ãã·ã¹ãã ãå¼ãç¶ãæ å½ã®äºº åå¹´å¾ã®èªåã§ãåããæé æ¸ã®æ¸ãæ¹ã«å°ã£ã¦ãã人 ï¼ãã®è¨äºãèªãã®ã«ãããæéã®ç®å®ï¼5åï¼ 1. ããã¥ã¡ã³ãã®åé ã«æ¸ãã㨠ã¾ãåã ã®è©³ç´°æé ã®åã«ãããã¥ã¡ã³ãèªä½ã«ã¤ãã¦è¨è¼ãã¦ããããããã¨ã§ãã 1.1. ããã¥ã¡ã³ãã«æ¸ããã¦ãããã¨ã3è¡ã§æ¸ã ããã¥ã¡ã³ãã®æåã«ã¯ããã®ããã¥ã¡ã³ãã«ä½ãæ¸ããã¦ããã®ãã100æåãããã§æ¸ãã¦ããã¨è¯ãã§ãããã ã·ã¹ãã ãå¢ããã°å¢ããã»ã©æé æ¸ãå¢ãã¦ãããã®ã§ããè¦ã¤ããããã¥ã¡ã³ãã«èªåã®æå¾ ãããã®ãæ¸ããã¦ããã®ããåé æ°è¡ã§ãããããã«ãªã£ã¦ããã¨ããããã§ãã 1
Velocity gives your Windows desktop offline access to over 150 API documentation sets (provided by Dash for OSÂ X) Download Buy Now A Huge Documentation Library Over 150+ API documentation sets are available in Velocity covering some of the most popular languages and API frameworks that you use for everyday development. If you've every seen or used Dash on the Mac then you have a good idea of what
ã¯ããã« ããã«ã¡ã¯ãSphinx Advent Calendar 2012 ã®4æ¥ç®ã®ã¨ã³ããªã§ãã@tk0miyaããåãåãã¾ããã Sphinx ã使ãå§ãã¦ã¾ã æ¥ãæµ ãã§ããå®éã«ä»äºã§ä½¿ã£ã¦ã¿ã¦ãã°ããããã¼ã«ã ã¨ä»æ´ãªããæ°ã¥ããSphinx ã«ç¹åããã¨ã³ããªã¨ããããã Sphinx + blogckdiag ã使ã£ã¦ä»äºã«ä½¿ãããã¤ã¢ã°ã©ã ã®è¡¨ç¾æ¹æ³ã«ã¤ãã¦ãç´¹ä»ãã¾ãã éããã°ã©ãã§ãç°¡åã«ä½æãã§ãä¿®æ£ãç°¡åãã¤ã©ã¤ã©ããªãã§ãµã¯ãµã¯ã¨å³ãæ¸ãã¾ãã ã½ããã¦ã§ã¢éçºããã¸ã§ã¯ãã§ä½æãããããã¥ã¡ã³ã(ç¹ã«ããã¥ã¢ã«ã§å©ç¨)ã¯é¡§å®¢ã«èª¬æããããã®å³è§£ãå¤ç¨ãã¾ããããã¾ã§ã®çµé¨ã§ Word/Excel ã®æç»ãã¼ã«ãã¤ãã£ã¦ããã°ã£ã¦ä½ã£ãå³ èª¿æ´ã¨ç·¨éãã¨ã¦ãå¤§å¤ Visio ã使ã£ã¦ãããããã綺éºã«ä½æããã¦ããããWord/Excel/PowerPoi
Twitter ã§ç¥äººã«ç´¹ä»ãããå¨å²ãããããã¯ä¾¿å©ãã¨ãã声ãçµæ§èããã¦ããã®ã§ãããã°ã§ãç´¹ä»ãã¦ããããDash ã¨ããããã¥ã¡ã³ããã¥ã¼ã¯ã¼ã iOS ã RubyMotionãããã㯠node ã ruby ãã®ã»ãã®ããã¥ã¢ã«ãã¾ã¨ãã¦ã¤ã³ã¯ãªã¡ã³ã¿ã«ãµã¼ãã㦠API ã調ã¹ããã¨ãããã¨ãã§ãããã¡ã¸ã£ã¼ãªè²ããªè¨èªã«å¯¾å¿ãã¦ããã æ¬æ¥ Dash 㯠"Snippet Manager" ã¨ãããã¨ã§ãã³ã¼ãã¹ããããã管çããããã®ã¢ããªã±ã¼ã·ã§ã³ã®ããã ãã©èªåã¯åãªãããã¥ã¡ã³ããã¥ã¼ã¯ã¼ã¨ãã¦ãã使ã£ã¦ããªããRubyMotion ã®åå¼·ä¼ã«è¡ã£ãã¨ãã«ãããã便å©ã¨ããã®ãæãã¦ããã£ã¦ãã®å¾æç¨ãã¦ãã¾ãã主㫠iOS ã®éçºã®ã¨ãã«å©ç¨ãã¦ããã http://satococoa.github.com/blog/2013/01/22/view-rdoc-
ã©ã³ãã³ã°
ã©ã³ãã³ã°
ãç¥ãã
ãªãªã¼ã¹ãé害æ å ±ãªã©ã®ãµã¼ãã¹ã®ãç¥ãã
ææ°ã®äººæ°ã¨ã³ããªã¼ã®é ä¿¡
å¦çãå®è¡ä¸ã§ã
j次ã®ããã¯ãã¼ã¯
kåã®ããã¯ãã¼ã¯
lãã¨ã§èªã
eã³ã¡ã³ãä¸è¦§ãéã
oãã¼ã¸ãéã
{{#tags}}- {{label}}
{{/tags}}