テクニカルライティングã®åŸºæœ¬
テクニカルライティングã®åŸºæœ¬ã‚’å¦ã¹ã¾ã™ã€‚サイボウズã®æ–°å…¥ç¤¾å“¡å‘ã‘ç ”ä¿®è³‡æ–™ã§ã™ã€‚æ¥å‹™ãƒžãƒ‹ãƒ¥ã‚¢ãƒ«ã€å ±å‘Šæ›¸ã€ä»•æ§˜æ›¸ã€æŠ€è¡“解説書ãªã©ã®ãƒ‰ã‚ュメントを書ã機会ãŒã‚ã‚‹æ–¹å‘ã‘。 Twitter：https://twitter.com/naoh_nak 2023年度ã®ã‚¢ãƒƒãƒ—デート版もã‚ã‚Šã¾ã™ï¼šhttps://spe…
Web開発・オンボーディング・採用ã®å®Ÿä¾‹ã«å¦ã¶ã€ãƒªãƒ¢ãƒ¼ãƒˆãƒ¯ãƒ¼ã‚¯ã®ã‚³ãƒŸãƒ¥ãƒ‹ã‚±ãƒ¼ã‚·ãƒ§ãƒ³ã¨æ–‡æ›¸è¡“ - エンジニアHub｜Webエンジニアã®ã‚ャリアを考ãˆã‚‹ï¼
Web開発・オンボーディング・採用ã®å®Ÿä¾‹ã«å¦ã¶ã€ãƒªãƒ¢ãƒ¼ãƒˆãƒ¯ãƒ¼ã‚¯ã®ã‚³ãƒŸãƒ¥ãƒ‹ã‚±ãƒ¼ã‚·ãƒ§ãƒ³ã¨æ–‡æ›¸è¡“ リモートワークã¸ã®æ³¨ç›®ãŒé«˜ã¾ã£ã¦ã„ã¾ã™ãŒã€ã„ã–é‹ç”¨ã™ã‚‹ã¨å¯¾é¢ã¨ã¯ç•°ãªã‚‹ã‚³ãƒŸãƒ¥ãƒ‹ã‚±ãƒ¼ã‚·ãƒ§ãƒ³ã«å››è‹¦å…«è‹¦ã—ã¦ã„ã‚‹ã®ã§ã¯ãªã„ã§ã—ょã†ã‹ã€‚本記事ã§ã¯ãƒªãƒ¢ãƒ¼ãƒˆãƒ¯ãƒ¼ã‚¯ã‚’長年実践ã—ã¦ã„ã‚‹YassLabæ ªå¼ä¼šç¤¾ã®å®‰å·è¦å¹³ï¼ˆ@yasulab）ã•ã‚“ã«ã€å…·ä½“例を交ãˆãªãŒã‚‰è§£èª¬ã—ã¦ã„ãŸã ãã¾ã™ã€‚ ã¯ã˜ã‚ã¾ã—ã¦ï¼ 2012å¹´ã«å‰µæ¥ã—ã€å‰µæ¥å½“åˆã‹ã‚‰ãƒªãƒ¢ãƒ¼ãƒˆãƒ¯ãƒ¼ã‚¯ã§åƒã„ã¦ã„ã‚‹YassLabæ ªå¼ä¼šç¤¾ã®å®‰å·ï¼ˆ@yasulab）ã§ã™ã€‚弊社ã§ã¯ã€RailsガイドやRailsãƒãƒ¥ãƒ¼ãƒˆãƒªã‚¢ãƒ«ã¨ã„ã£ãŸå¤§åž‹ã‚³ãƒ³ãƒ†ãƒ³ãƒ„を日々更新ã—ã€36時間以上ã‚る解説動画や1,400ページ超ãˆã®é›»å書ç±ãªã©ã‚’個人・法人å‘ã‘ã«æä¾›ã—ã¦ã„ã¾ã™ã€‚ 本記事ã§ã¯ã€8å¹´ã»ã©å®Ÿè·µã—ã¦ããŸãƒªãƒ¢ãƒ¼ãƒˆãƒ¯ãƒ¼ã‚¯ã®ä¸ã§ã€èªè€…ã®çš†ã•ã‚“ã«å½¹ç«‹ã¤ï¼ˆã‹ã‚‚ã—ã‚Œãªã„）実例をã„ãã¤ã‹ã”紹介ã—ã¾ã™ã€‚日々ã®
スケールã™ã‚‹çµ„織を支ãˆã‚‹ãƒ‰ã‚ュメンテーションã®æŠ€è¡“ã‚’â€GitLab Handbookâ€ã‹ã‚‰å¦ã¶ï½œå®‰é‡Žè²´åš
ドã‚ュメント文化ã¯å¥å…¨ãªçµ„ç¹”ã®ã‚¹ã‚±ãƒ¼ãƒ«ã®ãŸã‚ã«å¿…è¦ã€€çµ„ç¹”ã®ä¸ã§ãƒ‰ã‚ュメント/æ–‡ç« ã‚’æ®‹ã—活用ã—ã¦ã„ãã“ã¨ã¯ã¨ã¦ã‚‚é‡è¦ã 。クオリティã®é«˜ã„ドã‚ュメントãŒã‚ã‚‹ã“ã¨ã§ã€çµ„ç¹”ã«æƒ…å ±ãŒæµé€šã—ã€é€æ˜Žæ€§ã‚’確ä¿ã§ãるよã†ã«ãªã‚‹ã€‚æƒ…å ±ã‚’æµé€šã•ã›ã‚‹ãŸã‚ã«ã„ã¡ã„ã¡å£é ã®èª¬æ˜ŽãŒã„らãªã„ã‹ã‚‰ã€ãƒ¡ãƒ³ãƒãƒ¼ã®æ•°ãŒå¢—ãˆãŸæ™‚ã§ã‚‚スケールã—ã‚„ã™ããªã‚‹ã€‚éŽåŽ»ã®çµè«–ã«ã‚¢ã‚¯ã‚»ã‚¹å¯èƒ½ã«ãªã‚‹ã®ã§ã€è°è«–ã‚’ç©ã¿ä¸Šã’ã¦ã„ãã€æ„æ€æ±ºå®šã®ã‚¯ã‚ªãƒªãƒ†ã‚£ã‚’高ã‚ã‚‹ã“ã¨ã«ã‚‚ã¤ãªãŒã‚‹ã€‚ãã‚‚ãも何ã‹ã‚’èªã‚€ã¨ã„ã†ã“ã¨ã¯ä½•ã‹ã‚’èžã„ã¦æ•™ã‚るよりも時間ã‚ãŸã‚Šã®å‡¦ç†é‡ãŒå¤šã„ã—ã€éžåŒæœŸã«å®Ÿæ–½ã§ãる。良ã„ドã‚ュメントをアセットã¨ã—ã¦ç¤¾å†…ã«è“„ç©ã—ã¦ã„ãã“ã¨ã¯ã‚¹ã‚¿ãƒ¼ãƒˆã‚¢ãƒƒãƒ—ã®ã¿ãªã‚‰ãšã€ã‚ã‚Šã¨ã‚らゆる組織ãŒæˆé•·ã—ã¦ã„ã上ã§ã¨ã¦ã‚‚é‡è¦ã§ã‚ã‚‹ã¨è¨€ãˆã‚‹ã€‚ ã—ã‹ã—ãã®ä¸€æ–¹ã§ã€è‰¯è³ªãªãƒ‰ã‚ュメント文化を徹底ã§ãã¦ã„る会社ã¯å¤šããªã„よã†ã«è¦‹ãˆã‚‹ã€‚例ãˆã°ã€ç¤¾å†…ã®ãƒ‰ã‚ュメントを蓄ç©ã•ã›ã¦ã„ãå ´æ‰€ã¨ã—
開発者ã®é–‹ç™ºè€…ã«ã‚ˆã‚‹é–‹ç™ºè€…ã®ãŸã‚ã®Agileドã‚ュメンテーション - Qiita
開発者ã§ã‚ã‚Œã°é¿ã‘ã¦ã¯é€šã‚Œãªã„ドã‚ュメンテーション。 ã—ã‹ã—多ãã®é–‹ç™ºè€…ãŒå«ŒãŒã£ã¦ã„るドã‚ュメンテーション。 今回ã¯ã‚¢ã‚¸ãƒ£ã‚¤ãƒ«åž‹é–‹ç™ºï¼ˆä»¥ä¸‹ã€ã‚¢ã‚¸ãƒ£ã‚¤ãƒ«ï¼‰ã®ãƒ—ãƒã‚¸ã‚§ã‚¯ãƒˆãƒ»ãƒãƒ¼ãƒ 開発者ã«ãŠã‘る最é©ãªãƒ‰ã‚ュメンテーションã«ã¤ã„ã¦è€ƒå¯Ÿã—ãŸã„ã¨æ€ã„ã¾ã™ã€‚ アジャイルã¨ãƒ‰ã‚ュメント ドã‚ュメントã¯æ›¸ã‹ãªãã¦è‰¯ã„？ 日本ã«ãŠã„ã¦ã‚¢ã‚¸ãƒ£ã‚¤ãƒ«ã¯ã‚†ã£ãã‚Šã ãŒç¢ºå®Ÿã«æµ¸é€ã—ã¦ã„ã¾ã™ã€‚ 7年間アジャイルをã—ã¦ã„ãŸç§ã¨ã—ã¦ã¯å¬‰ã—ãæ€ã†åé¢ã€ä¸–é–“ã«ã¯èª¤ã£ãŸèªè˜ãŒåºƒãŒã£ã¦ã„ã‚‹ã®ã‚‚ã¾ãŸäº‹å®Ÿã§ã™ã€‚以下ã¯ã‚¢ã‚¸ãƒ£ã‚¤ãƒ«å‹˜é•ã„集ã®æŠœç²‹ã§ã™ã€‚ Q. ドã‚ュメントを書ã‹ãªã„？ ã‚‚ã¡ã‚んアジャイルプãƒã‚»ã‚¹ã§ã‚‚ドã‚ュメントã¯æ›¸ãã¾ã™ã€‚ãŸã å„ªå…ˆé †ä½ãŒç•°ãªã‚‹ã ã‘ã§ã™ã€‚ ... 最å°é™ã®æ–‡æ›¸åŒ–ã§æœ€å¤§é™ã®åŠ¹æžœã‚’ç‹™ã†ã€å¿…è¦ã«ã—ã¦å分ãªãƒ‰ã‚ュメント。ãã†ã—ãŸãƒ‰ã‚ュメントã¯ä¸€æœä¸€å¤•ã«æ›¸ã‘ã‚‹ã‚‚ã®ã§ã¯ã‚ã‚Šã¾ã›ã‚“。 ― ドã‚ュメントを書ã‹ãªã„？｜アジャイル勘é•
我々ã¯ã„ã‹ã«ã‚·ã‚¹ãƒ†ãƒ 開発ã«ãŠã‘るドã‚ュメントè…ã‚‹å•é¡Œã¨æˆ¦ãˆã°è‰¯ã„ã®ã‹
フューãƒãƒ£ãƒ¼ã‚¢ãƒ¼ã‚テクト Advent Calendar 2017 ã®2日目ã§ã™ã€‚ システムè¨è¨ˆãŒå¤§å¥½ãã§å¤§å«Œã„ãªçš†ã•ã‚“ã€ã“ã‚“ã«ã¡ã¯ã€‚ çªç„¶ã§ã™ãŒã€çš†ã•ã‚“ã¯ã©ã®ã‚ˆã†ã«ã‚·ã‚¹ãƒ†ãƒ è¨è¨ˆã«ãŠã‘ã‚‹ ドã‚ュメントè…ã‚‹å•é¡Œ ã«ç«‹ã¡å‘ã‹ã£ã¦ã„ã¾ã™ã‹ï¼Ÿ … ドã‚ュメントè…ã‚‹å•é¡Œã¨ã¯ã€è¨è¨ˆæ™‚ã«ä½œæˆã—ãŸå„種ドã‚ュメントãŒGoogle Driveやファイルサーãƒä¸Šã§é™³è…化ã—ã¦ã—ã¾ã„ã€ç¾çŠ¶ã®æ£ã—ã„状態を指ã—ã¦ã„ãªã„ã“ã¨ã§ã™ã€‚ã›ã£ã‹ãæ–°è¦å‚画者ãŒã‚ャッãƒã‚¢ãƒƒãƒ—ã—よã†ã¨ã—ã¦ã‚‚ドã‚ュメントãŒçœŸå®Ÿã‚’示ã—ã¦ã„ãªã„ã¨ã„ã†æ€–ã„ã‚„ã¤ã§ã™ã‚ˆã。 今ã¾ã§å‡ºä¼šã£ãŸä¸€ç•ªè¾›ã„ドã‚ュメントã¯ã€PJåˆæœŸã«ä½œæˆã—ãŸãƒ›ãƒ¯ã‚¤ãƒˆãƒœãƒ¼ãƒ‰ã«æ›¸ã‹ã‚ŒãŸãƒ©ãƒ•ã‚¹ã‚±ãƒƒãƒã®ç”»åƒã—ã‹ç„¡ã‹ã£ãŸã¨ã“ã‚ã§ã™ã。ã¾ãšå—ãŒæ±šã„ã—ã€å†…容も最新版ã¨å¾®å¦™ã«ç•°ãªã£ã¦ã„ã¾ã—ãŸã€‚æ–°è¦å‚画者殺ã—ã«ã‚‚ã»ã©ãŒã‚ã‚‹ã¨ã€ã»ã‚“ã®ã¡ã‚‡ã£ã¨ã ã‘æ¨ã¿ã¾ã—ãŸã€‚ ã„ã‚„ã„ã‚„ã€ã¡ã‚ƒã‚“ã¨ã‚µãƒœã‚‰ãšæ•´åˆæ€§ã‚’å–れよã£ã¦ï¼Ÿã‚µãƒœ
プãƒãƒ€ã‚¯ãƒˆã®ãƒ‰ã‚ュメントã«ãƒ—ルリクエストをé€ã‚Œã‚‹ä»•çµ„ã¿ãŒã™ã”ã„ - Qiita
ã“れ↓ãªã‚“ã§ã™ã‘ã©ã€æ„外㨠RT ã‚„ Like ãŒä»˜ã„ã¦ãŸã®ã§ã€ã¡ã‚ƒã‚“ã¨æ›¸ãã¾ã™ã。 ã—ã£ã‹ã—Microsoftã®ãƒ‰ã‚ュメントシステム良ã出æ¥ã¦ã‚‹ãªãƒ¼ã€‚å³ã®Editボタン押ã™ã¨GitHubãŒé–‹ã„ã¦ã™ãPRé€ã‚Œã‚‹ã€‚ã‚ã¡ã‚‰ã§ãƒžãƒ¼ã‚¸ã•ã‚Œã‚Œã°å³ã‚µã‚¤ãƒˆã«åæ˜ ã•ã‚Œã‚‹ã€‚Contiributorsã«è‡ªåˆ†ã®ã‚¢ã‚¤ã‚³ãƒ³ãŒå¢—ãˆãŸâ™ª ã“ã‚Œã¯ãƒ•ã‚£ãƒ¼ãƒ‰ãƒãƒƒã‚¯ã™ã‚‹ã®ã«ã€Œé¢å€’ã€ã¯ç†ç”±ã«ã§ããªã„ã§ã™ãžã€‚https://t.co/9KhAwhV5PP pic.twitter.com/r46zFUvkEp — ã‚ã‚ã„ã±ã‚ーã«ãŠã¾ã‹ã›ã‚! (@amay077) 2018å¹´6月12æ—¥ ã“ã®ãƒ„イ㯠Microsoft ã®è£½å“やサービスã®ãƒ‰ã‚ュメントã«ã¤ã„ã¦ãªã‚“ã§ã™ãŒã€ Microsoft Docs ã¨ã„ã†ãƒãƒ¼ã‚¿ãƒ«ãŒã‚ã‚Šã¾ã—ã¦ã€åŒç¤¾ã®ã‚µãƒ¼ãƒ“スã®å¤šãã¯ã“ã“ã§ãƒ‰ã‚ュメント公開ã•ã‚Œã¦ã„る模様ã§ã™ã€‚ ã“ã“ã§å…¬é–‹ã•ã‚Œã¦ã„るドã‚ュメント群ã¯ã€ãƒãƒƒã‚¯
エンジニアæ´20æ•°å¹´ã®ç§ãŒã€è¨è¨ˆæ›¸ã‚’書ãéš›ã«å¿ƒãŒã‘ã¦ã„ã‚‹ã“㨠- Qiita
Deleted articles cannot be recovered. Draft of this article would be also deleted. Are you sure you want to delete this article? ã¯ã˜ã‚㫠時ã®çµŒã¤ã®ã¯æ—©ã„ã‚‚ã®ã§ã€ç§ãŒITæ¥ç•Œã«èº«ã‚’ç½®ã„ã¦å››åŠä¸–ç´€ã«ãªã£ã¦ã—ã¾ã„ã¾ã—ãŸã€‚ ãã®é–“ã€è†¨å¤§ãªæ•°ã®ã€Œè¨è¨ˆæ›¸ï¼ˆä»•æ§˜æ›¸ï¼‰ã€ã‚’書ã„ã¦æ¥ã¾ã—ãŸãŒã€æœªã ã«æ‚©ã¿ãƒ»è¿·ã„ã¯å°½ãã¾ã›ã‚“。 ãã‚Œã§ã‚‚ã€äº€ã®ç”²ã‚ˆã‚Šå¹´ã®åŠ«ã¨ã‚‚申ã—ã¾ã™ã®ã§ã€ç§ãªã‚Šã®çµŒé¨“則を「個人ã€ã¨ã€Œãƒãƒ¼ãƒ ã€ã®ä¸¡è¦³ç‚¹ã§ã¾ã¨ã‚ã¦ã¿ã¾ã—ãŸã€‚ 本稿ã®ãƒ†ãƒ¼ãƒžã¯ã€ã€Œä¸»ã«è¨è¨ˆæ›¸ã‚’想定ã—ãŸã€é–‹ç™ºãƒ‰ã‚ュメントã®æ›¸ãæ–¹ã€ã§ã™ã€‚ 本稿ã§å‰æã¨ã™ã‚‹è¨è¨ˆæ›¸ã¯ã€Excelã‚„Wordã§æ›¸ã‹ã‚ŒãŸã€ãƒ•ã‚©ãƒ¼ãƒžãƒ«ãªï¼ˆâ‰’ç´å“物ã«ãªã‚Šãˆã‚‹ï¼‰è¨è¨ˆæ–‡æ›¸ã€ã§ã™ã€‚ ã—ãŸãŒã£ã¦ã€è‡ªç¤¾ã‚µãƒ¼ãƒ“ス開発よりもå—託開発ã€ã‚¢ã‚¸ãƒ£ã‚¤ãƒ«ã‚ˆã‚Šã‚‚ウォータ
Documentation Driven Contractsã«ã¤ã„ã¦èª¿ã¹ã¦ã¿ãŸ - mookjp.io
Documentation Driven Contractsã«ã¤ã„ã¦èª¿ã¹ã¦ã¿ãŸ May 15, 2017 ( May 15, 2017 æ›´æ–° ) モãƒãƒ™ãƒ¼ã‚·ãƒ§ãƒ³ 最近æ¥å‹™ã§ã€ç¤¾å†…ã®ä»–ã®ãƒãƒ¼ãƒ ã«æä¾›ã™ã‚‹APIを開発ã—ã¦ã„る。 é–¢ã‚ã£ã¦ã„る人ãŒå°‘ãªã‘ã‚Œã°ã€ã¿ã‚“ãªã§è¿‘ãã«åº§ã£ã¦éƒ½åº¦ä»•æ§˜ã«ã¤ã„ã¦ç›¸è«‡ã—ã¦ã„ã‘ã°ã„ã„。（感覚的ã«ã¯ã€œ7人ãらã„？） ã—ã‹ã—ã€ä¼šç¤¾å…¨ä½“ã®äººæ•°ãŒå¤šãã€é–¢ã‚ã‚‹ãƒãƒ¼ãƒ も複数ã„ã‚‹ãŸã‚（サービスã®ãƒ¢ãƒã‚¤ãƒ«ã‚¢ãƒ—リ担当ã€Webフãƒãƒ³ãƒˆæ‹…当ã€ãƒãƒƒã‚¯ã‚¨ãƒ³ãƒ‰æ‹…当…ãªã©ï¼‰åŒ…括的ã§éƒ½åº¦æ›´æ–°ã•ã‚Œã‚‹ãƒ‰ã‚ュメントãŒãªã„ã¨é–‹ç™ºåŠ¹çŽ‡ãŒæ‚ªã„。 ã¨ã¯ã„ãˆã€APIæä¾›ãƒãƒ¼ãƒ ã¨ã—ã¦ã¯ã€å®Ÿè£…ã«ãªã‚‹ã¹ã多ãã®æ™‚間を使ã„ãŸã„。具体的ã«ã¯ä»¥ä¸‹ã®æ¡ä»¶ã‚’満ãŸã™æ‰‹æ³•ãŒã‚ã‚Œã°ã‚ˆã„: ドã‚ュメント作æˆã«ã‹ã‘る時間をçŸãã§ãã‚‹ 作æˆã—ãŸãƒ‰ã‚ュメントã®å†…容ãŒæ£ç¢ºï¼ˆæœ€æ–°ã§ã‚ã‚‹ã“ã¨ãŒå¿…é ˆï¼‰ 一番原始的ãªæ‰‹æ³•ã¨ã—ã¦ã€ãƒ‰ã‚ュメントをã¡ã¾ã¡ã¾äººæ‰‹
#テクシオ ã§ã€ŒDevOpsã¨ãƒ‰ã‚ュメントデザインパターンã€ã®è©±ã‚’ã—ã¾ã—ãŸï¼‹Î± - 下町柚å黄æ˜è¨˜ by @yuzutas0
æ¦‚è¦ å…ˆæ—¥ã€Tech Night @ Shiodome # 4ã¨ã„ã†ã‚¤ãƒ™ãƒ³ãƒˆã«å‚åŠ ã—ã¦ã€LTã‚’ã—ã¦ãã¾ã—ãŸã€‚ ã©ã‚“ãªã‚¤ãƒ™ãƒ³ãƒˆã‹ 「DevOpsã¨è‡ªå‹•åŒ–ã€ã‚’テーマã«ã€äº‹ä¾‹ãƒ»çŸ¥è¦‹ã‚’共有ã™ã‚‹å ´ã§ã—ãŸã€‚ ã‚‚ã¨ã¯ã‚½ãƒ•ãƒˆãƒãƒ³ã‚¯æ§˜ã®ç¤¾å†…勉強会ã§ã€Œå¤–部ゲストを呼㶠→ 公開イベントã«ãªã£ãŸã€ã¨ã®ã“ã¨ã§ã™ã€‚ 社会ã«ã‚·ã‚§ã‚¢ã™ã‚‹å§¿å‹¢ãŒç´ 敵ã ã¨æ€ã„ã¾ã—ãŸã€‚ ä»–ã®å‚åŠ è€…ã®ç™ºè¡¨ ã‚ãŸã‚Šã¾ãˆã®ã“ã¨ã‚’ã‚ãŸã‚Šã¾ãˆã«ã‚„る難ã—ã• AWS ECS （EC2 Container Service）を用ã„㟠AWS ã¸ã®Docker コンテナデプãƒã‚¤ 自動化ã«ãŠã‘ã‚‹ã‚³ãƒ¼ãƒ‰ç®¡ç† é€ä¿¡ãƒ¡ãƒ¼ãƒ«ã‚µãƒ¼ãƒ“スをユニットテストã—ã¦ã¿ãŸ DevOpsã€æœ¬å½“ã®ã¨ã“ã‚ ã“ã¡ã‚‰ã®Connpassã®ãƒšãƒ¼ã‚¸ã«è³‡æ–™ãŒä¸ŠãŒã£ã¦ã„ã¾ã™ã€‚ ã©ã‚“ãªè©±ã‚’ã—ã¦ããŸã‹ ã“ã¡ã‚‰ãŒå½“æ—¥ã®ç™ºè¡¨è³‡æ–™ã«ãªã‚Šã¾ã™ã€‚ ã–ã£ãり説明ã™ã‚‹ã¨ DevOps（全体最é©åŒ–）ã®å‰ã«ã€æ¥å‹™æ¨™æº–化（ドã‚ュメ
[Apiary]Markdownã§å§‹ã‚ã‚‹API開発ã¨APIドã‚ãƒ¥ãƒ¡ãƒ³ãƒˆä½œæˆ | DevelopersIO
APIを作るã¨ã ã¿ãªã•ã‚“ã€æ¯Žæ—¥API使ã£ã¦ã¾ã™ã‹ï¼Ÿç§ã¯ã€ãƒ¯ãƒ³ãƒ©ã‚¤ãƒŠãƒ¼ã§APIをコールã™ã‚‹ã“ã¨ã«ãƒãƒžã£ã¦ã„ã¾ã™ã€‚ã•ã¦ã€ã„ã¤ã‚‚使ã£ã¦ã„ã‚‹APIを作るå´ã«ãªã£ãŸã¨ãã€ã©ã®ã‚ˆã†ã«è¨è¨ˆã—ã¦ã„ã¾ã™ã§ã—ょã†ã‹ï¼Ÿã¾ãŸã€ä½œã£ãŸAPIã‚’ã©ã®ã‚ˆã†ã«ä½¿ã£ã¦ã‚‚らã£ã¦ã„ã¾ã™ã‹ï¼Ÿãã‚“ãªç–‘å•ã«å¿œãˆã‚‹ã‚µãƒ¼ãƒ“スãŒApiaryã§ã™ã€‚ Apiaryã¨ã¯ï¼Ÿ Apiaryã¯ã€REST APIをサクッã¨æ›¸ã‘るサービスã§ã™ã€‚ã¾ãŸã€APIドã‚ュメントも生æˆã—ã¦ãã‚Œã¾ã™ã€‚モックサーãƒã‚‚æä¾›ã—ã¦ãã‚Œã¾ã™ã€‚API利用サンプルコードも作ã£ã¦ãã‚Œã¾ã™ã€‚ã†ã‚“ã€ä½¿ã‚ãªã„ã£ã¦é¸æŠžè‚¢ã¯ç„¡ã„ã§ã™ãｗ。 無料登録ã™ã‚‹ã¨æ—©é€Ÿä½¿ãˆã‚‹ã‚ˆã†ã«ãªã‚Šã¾ã™ã€‚ãƒãƒ¼ãƒ ã§ãƒ—ライベートãªAPI開発をã—ãŸã‘ã‚Œã°æœ‰æ–™ãƒ—ランをé¸æŠžã—ã¦ãã ã•ã„。 API開発ã®æµã‚Œ API開発ã®æµã‚Œã¯ã€ã¾ãšã¯ã˜ã‚ã«Markdownå½¢å¼ã§ãƒ‰ã‚ュメントを書ãã¾ã™ã€‚æ—¢ã«ã‚µãƒ³ãƒ—ルãŒã‚ã‚‹ã®ã§ã“れを使ã£ã¦ã¿ã¾ã—ょã†ã€‚
![[Apiary]Markdownã§å§‹ã‚ã‚‹API開発ã¨APIドã‚ãƒ¥ãƒ¡ãƒ³ãƒˆä½œæˆ | DevelopersIO](https://cdn-ak-scissors.b.st-hatena.com/image/square/60d7120d91185f1739fec5fcbd006f066b98e9f6/height=288;version=1;width=512/https%3A%2F%2Fdevio2023-media.developers.io%2Fwp-content%2Fuploads%2F2015%2F02%2Fapiary-logo.png){kind=logo}
ã‚ã‹ã‚Šã‚„ã™ã„README.mdを書ã
GitHubãªã©ã«è‡ªåˆ†ã®ãƒ„ールやライブラリを公開ã™ã‚‹ã¨ã，README.mdã¯é‡è¦ãªå½¹å‰²ã‚’æ‹…ã£ã¦ã„る．レãƒã‚¸ãƒˆãƒªã‚’訪れãŸãƒ¦ãƒ¼ã‚¶ãŒè‡ªåˆ†ã®ãƒ„ールを使ã£ã¦ãれるã‹å¦ã‹ã®ç¬¬ä¸€æ©ã¯README.mdã«ã‹ã‹ã£ã¦ã„る，ã¨è¨€ã£ã¦ã‚‚éŽè¨€ã§ã¯ãªã„．実際自分ãŒä½¿ã†å´ã«ãªã£ãŸã¨ãも，ã¾ãšREADME.mdã‚’èªã‚“ã§åˆ¤æ–ã—ã¦ã„ã‚‹ã¨æ€ã†ï¼Ž æˆåŠŸã—ã¦ã„るプãƒã‚¸ã‚§ã‚¯ãƒˆã‚’å‚考ã«ã—ã¤ã¤ï¼Œè‡ªåˆ†ãŒå®Ÿè·µã—ã¦ã„ã‚‹ã“ã¨ã‚’ã¾ã¨ã‚ã¦ãŠã．ã“ã“ã«æ›¸ã„ã¦ã„ã‚‹ã“ã¨ã¯ã‚ãã¾ã§ï¼ˆè‡ªåˆ†ã®ä¸ã§ï¼‰æœ€ä½Žé™çš„ãªã‚‚ã®ã§ã‚る．プãƒã‚¸ã‚§ã‚¯ãƒˆãŒæˆé•·ã—ã¦ã„ãã«ã¤ã‚Œã¦READMEã¯ã‚ã‚‹ã¹ã姿ã«æˆé•·ã—ã¦ã„ãã¹ãã ã¨æ€ã†ï¼Ž READMEã®å½¹å‰² README.mdã«ã¯å¤§ãã2ã¤ã®å½¹å‰²ãŒã‚る． プãƒã‚¸ã‚§ã‚¯ãƒˆï¼Œãƒ„ールã®ä½¿ã„方，インストール方法 プãƒã‚¸ã‚§ã‚¯ãƒˆï¼Œãƒ„ールã®å®£ä¼ 元々READMEã¯å‰è€…ã®å½¹å‰²ã—ã‹ãªã‹ã£ãŸãŒï¼ŒGitHubã®ä»•çµ„ã¿ä¸Šï¼Œå¾Œè€…ã®å½¹å‰²ã‚‚å¾ã€…ã«é‡è¦ã«ãªã£ã¦ã„る． ã•ã‚‰ã«
Rubyã§å®šç¾©ã—ãŸãƒ¡ã‚½ãƒƒãƒ‰ã®ä½¿ç”¨ä¾‹ã‚’YARD用ã®ãƒ‰ã‚ュメントã¨ã—ã¦æ›¸ã方法 - 2013-09-19 - ククãƒã‚°
ã¯ã˜ã‚ã« YARDã¨ã„ã†Ruby用ã®ãƒ‰ã‚ュメンテーションツールãŒã‚ã‚Šã¾ã™ã€‚APIã®ãƒ‰ã‚ュメントã®è¨˜è¿°æ–¹æ³•ã¯å¤§ãã2種類ã‚ã‚Šã¾ã™ãŒã€YARDã¯ã‚³ãƒ¼ãƒ‰ã«ã‚³ãƒ¡ãƒ³ãƒˆã¨ã—ã¦ãƒ‰ã‚ュメントを埋ã‚込む形å¼ã‚’採用ã—ã¦ã„ã¾ã™ã€‚専用ã®è¨˜æ³•ã‚’使ã£ã¦æ§‹é€ 化ã•ã‚ŒãŸèªã¿ã‚„ã™ã„ドã‚ュメントを書ã‘ã‚‹ã“ã¨ãŒé¡žä¼¼ãƒ„ールã§ã‚ã‚‹RDocã¨ã®å¤§ããªé•ã„ã§ã™ã€‚ 今回ã¯ã€ŒRubyã§å®šç¾©ã—ãŸãƒ¡ã‚½ãƒƒãƒ‰ã®ä½¿ç”¨ä¾‹ã‚’示ã™ã€ãƒ‰ã‚ュメントã®YARDæµã®æ›¸ã方を紹介ã—ã¾ã™ã€‚ ãªãœä½¿ç”¨ä¾‹ã®æ›¸ã方を説明ã™ã‚‹ã‹ã¨ã„ã†ã¨ã€ä½¿ç”¨ä¾‹ã‚’1ã¤ç¤ºã™ã ã‘ã§ä½¿ã„方をãã£ã¨ã‚ã‹ã‚Šã‚„ã™ã説明ã™ã‚‹ã“ã¨ãŒã§ãã‚‹ã‹ã‚‰ã§ã™ã€‚ã‚‚ã¡ã‚ã‚“ã€å¼•æ•°ã‚„戻り値ãªã©ãƒ¡ã‚½ãƒƒãƒ‰ã«ã¤ã„ã¦ã®æƒ…å ±ã‚‚å¿…è¦ã§ã™ãŒã€ãれらã¯æ–片的ãªæƒ…å ±ãªãŸã‚ã€ãã“ã‹ã‚‰å…¨ä½“åƒã‚’イメージã™ã‚‹ã«ã¯ã‚‚ã†ã²ã¨ã‚¹ãƒ†ãƒƒãƒ—å¿…è¦ã«ãªã‚Šã¾ã™ã€‚一方ã€ä½¿ç”¨ä¾‹ã¯è©³ç´°ã‚’示ã™ã“ã¨ã«ã¯ä¸å‘ãã§ã™ãŒã€ã©ã‚“ãªçŠ¶æ³ã§ä½¿ã†ã®ã‹ã€ã©ã®ã‚ˆã†ã«æº–å‚™ã—ã¦ä½¿ã†ã®ã‹ã¨ã„ã£ãŸå‰å¾Œé–¢ä¿‚ã‚‚
軽é‡JSONパーサー『jqã€ã®ãƒ‰ã‚ュメント：『jq Manualã€ã‚’ã–ã£ãり日本語訳ã—ã¦ã¿ã¾ã—㟠| DevelopersIO
jq Manual jqã§ç°¡å˜JSONåŠ å·¥ ｜ Developers.IO jqコマンドãŒå®Ÿã¯é«˜æ€§èƒ½ã™ãŽã¦ãƒ“ビッãŸè©± - beatsync.net JSONを超絶ã«èªã¿ã‚„ã™ãã™ã‚‹ jq コマンド - WebAPIãƒãƒªãƒãƒªä½¿ã†or開発ã™ã‚‹äººå¿…é ˆ CLIã§JSONã®æ•´å½¢ã‚’ã™ã‚‹ - ( ꒪⌓꒪) ゆるよã‚日記 JSONå½¢å¼ã®æƒ…å ±ã‚’æ§˜ã€…ãªæ¡ä»¶ã‚„書å¼ã¨ã—ã¦æˆå½¢ã€ãƒ•ã‚£ãƒ«ã‚¿ãƒªãƒ³ã‚°ãƒ„ール『jqã€ã€‚上記関連エントリã§ç§ã‚‚ã“ã®ãƒ„ールã®å˜åœ¨ã‚’知る事ã«ãªã£ãŸã®ã§ã™ãŒã€ãƒ„ールã®ç°¡æ˜“ã•ãƒ»ä¾¿åˆ©ã•ã«æ„Ÿå‹•ã—ãªãŒã‚‰ç§ã‚‚ã¡ã‚‡ãã¡ã‚‡ã利用ã•ã›ã¦ã‚‚らã£ã¦ã„ã¾ã™ã€‚ ãã“ã§ã“ã®ã‚¨ãƒ³ãƒˆãƒªã§ã¯ã€jqå…¬å¼ãƒšãƒ¼ã‚¸ã«å±•é–‹ã•ã‚Œã¦ã„る利用ガイド・リファレンス的ãªä½ç½®ä»˜ã‘ã®ã€Žjq Manualã€ã‚’写経ãŒã¦ã‚‰ã–ã£ãり日本語訳ã—ã¦ã¿ã¾ã—ãŸã€‚ã–ã£ãり訳ãªã®ã§ã“ã®éƒ¨åˆ†ã®è¨³ãŠã‹ã—ã„・間é•ã£ã¦ã‚‹ç‰ã‚ã‚Šã¾ã—ãŸã‚‰å¾¡æŒ‡æ‘˜é ‚ã‘ã‚‹ã¨å¹¸ã„ã§ã™ã€‚例示ã•ã‚Œã¦ã„るサンプルコードも
Dash 㧠gem ã®ãƒ‰ã‚ュメントをå‚ç…§ã™ã‚‹ - satococoa's blog
@satococoa ã‚„ã£ã±ã‚¦ã‚§ãƒ–ã¿ã«ã„ãã‚“ã§ã™ãã€äº†è§£ã§ã™ã€‚ã“ã®è¾ºã‚‚ Dash ã¨ã‹ã§è¦‹ã‚Œã‚‹ã‚ˆã†ã«ã—ãŸã„ãªâ€” Naoya Itoã•ã‚“ (@naoya_ito) 1月 22, 2013 ã“ã‚“ãªè©±ã‹ã‚‰ã€ã‚¤ãƒ³ã‚¹ãƒˆãƒ¼ãƒ«ã—㟠gem ã®ãƒ‰ã‚ュメントãŒè¦‹ã‚‰ã‚Œã‚‹é¢¨ãª Docset ㌠Dash ã«ã‚ã£ãŸã®ã‚’æ€ã„出ã—ã¦ã¡ã‚‡ã£ã¨èª¿ã¹ã¦ã¿ã¾ã—ãŸã€‚ 以下ã®æ‰‹é †ã«æ²¿ã£ã¦ã¡ã‚‡ã“ã¡ã‚‡ã“ã£ã¨è¨å®šã‚’ã™ã‚‹ã¨ã€RDoc ã§ç”Ÿæˆã•ã‚ŒãŸ gem ã®ãƒ‰ã‚ュメントãŒè¦‹ã‚‰ã‚Œã¾ã—ãŸã€‚ è¨å®šæ–¹æ³• Preferences… -> Downloads ã‹ã‚‰ “Ruby Installed Gems†ã¨ã„ã†docsetをインストール Preferences… -> Docsets ã« Ruby Gems ã¨ã„ㆠdocset ãŒã‚ã‚‹ã®ã§ã€ãã®ä¸€ç•ªå³ã«ã‚るギヤã®ãƒœã‚¿ãƒ³ã‹ã‚‰rdocãŒç½®ã‹ã‚Œã¦ã„るパスをè¨å®šã™ã‚‹ã€‚gem env gempath ã¨
Full featured documentation deployment platform
Documentation simplified Build, host, and share documentation, all with a single platform. Sign up now Automatic deploy previews Preview your documentation on every pull request. Never guess what you're shipping again. Ideal developer experience Write documentation with Git and your favorite text editor. Developers and writers both love docs as code. Work privately or publicly Share content with j
1
リリースã€éšœå®³æƒ…å ±ãªã©ã®ã‚µãƒ¼ãƒ“スã®ãŠçŸ¥ã‚‰ã›
最新ã®äººæ°—エントリーã®é…ä¿¡
j次ã®ãƒ–ックマーク
kå‰ã®ãƒ–ックマーク
lã‚ã¨ã§èªã‚€
eコメント一覧を開ã
oページを開ã
{{#tags}}- {{label}}
{{/tags}}