Mintlify - The modern standard for documentationMeet the modern standard for public facing documentation. Beautiful out of the box, easy to maintain, and optimized for user engagement.
GitHub Next | Copilot for Docs
Whether you’re learning a new library or API or you’ve been using it for years, it can feel like the documentation gets in your way more than it helps. Maybe the tutorials are too basic, or the reference manual is too sketchy, or the relevant information is split across multiple pages full of irrelevant details. We’re exploring a way to get you the information you need, faster. By surfacing the mo
GitHub - hashicorp-forge/hermes: A document management system
Sign up for a Google Workspace account. Create a Google Cloud project. Enable the following APIs for Google Workspace APIs Admin SDK API (optional, if enabling Google Groups as document approvers) Google Docs API Google Drive API Gmail API People API Also, to enable searching for users, the Google Workspace domain admin needs to enable external directory sharing. See more details: https://support.
How Stripe builds interactive docs with Markdoc
At Stripe, our product docs are designed to feel like an application rather than a traditional user manual. For example, we incorporate a user's own API test key into code samples, making it possible to copy and paste code that seamlessly works with the user's own account. We have client-side interactivity, like checklists and collapsible sections. We tailor the content to the individual user, con
CHANGELOG ã®æ›¸ãæ–¹ - 角待ã¡ã¯å¯¾ç©º
VS Code ã®æ‹¡å¼µä½œã£ã¦ã„る際㫠CHANGELOG.md ãŒè‡ªå‹•ç”Ÿæˆã•ã‚Œã€æ›¸ãæ–¹ã¯Keep a Changelogã«å¾“ãˆã¨æ›¸ã‹ã‚Œã¦ã„ãŸã®ã§ç´¹ä»‹ã™ã‚‹ã€‚ ã“ã“ã«æ›¸ã‹ã‚Œã¦ã„ã‚‹ã“ã¨ã¯çµ¶å¯¾ã§ã¯ãªããŸã æ案ã—ã¦ã„ã‚‹ã ã‘ã§ã‚る。æ„見ãŒã‚る人ã¯è©±ã—åˆãŠã†ã¨ã„ã†æ¸©åº¦æ„Ÿã£ã½ã„ã®ã§ã€ç´å¾—ã„ã‹ãªã„å ´åˆã¯ issue ç«‹ã¦ã‚‹ã¨è‰¯ã„ã¨æ€ã†ã€‚ 僕自身ã¯ãªã‚“ã§ã‚‚よãã¦ã‚る程度型ãŒæ¬²ã—ã‹ã£ãŸã ã‘ãªã®ã§ã“ã‚Œã‹ã‚‰ã¯ã“ã‚Œã«å¾“ã£ã¦æ›¸ã„ã¦ã„ã“ã†ã¨æ€ã†ã€‚ãŸã ã¾ã Semantic Versioning ã‚‚ãã†ã ã‘ã©ã¡ã‚ƒã‚“ã¨å¾“ãŠã†ã¨ã™ã‚‹ã¨ä»¥ä¸Šã«ã ã‚‹ããªã£ã¦ãã‚‹ã®ã§é›°å›²æ°—従ã†ãらã„ã ã¨æ€ã†ã€‚ CHANGELOG ã®åŽŸå‰‡ 機械的ã«ç”Ÿæˆã™ã‚‹ã®ã§ã¯ãªã人間ã®æ‰‹ã§æ›¸ã å„セクションã¸ã®ãƒªãƒ³ã‚¯ãŒå®¹æ˜“ã«ã§ãã‚‹ 1ã¤ã®ãƒãƒ¼ã‚¸ãƒ§ãƒ³ã”ã¨ã«1ã¤ã®ã‚µãƒ–セクションを作る リリースã¯æ–°ã—ã„ã‚‚ã®ãŒä¸Šã«æ¥ã‚‹ã‚ˆã†ã«ã™ã‚‹ 日付ã®ãƒ•ã‚©ãƒ¼ãƒžãƒƒãƒˆã¯ YYYY-MM-DD
Treat code like code and prose like prose
Some recent experiences have prompted me to rethink the value of treating docs like code in some respects. I want to return to focusing more on content rather than technical workflows, especially when creating new content. Some of the docs-like-code processes exclude too many people in non-engineer roles who would otherwise contribute to the review and development of the content. “Prose like prose
Companies Using RFCs or Design Docs and Examples of These
RFCs - requests for comment - or Design Docs are a common tool that engineering teams use to build software faster, by clarifying assumptions and circulating plans earlier. There are some similarities between writing automated tests for your code, and writing RFCs before you start working on a non-trivial project: Software engineers who write tests for their code - and ask for code reviews on it -
ã€ç¿»è¨³ã€‘Googleã®ã‚¨ãƒ³ã‚¸ãƒ‹ã‚¢ãŒã‚½ãƒ•ãƒˆã‚¦ã‚§ã‚¢é–‹ç™ºã™ã‚‹æ™‚ã«å¿…ãšæ›¸ãドã‚ュメント「Design Docs at Google〠- BppLOG
Googleã§ã®ã€ŒDesign Docsã€ã¨ã¯ 2007å¹´ã® Google Developer Day Tokyo ã§ã®éµœé£¼æ°ã®ãƒ—レゼンã«ã‚ˆã‚‹ã¨ã€ŒGoogle ã§å¿…ãšæ›¸ãã“ã¨ã«ãªã£ã¦ã„るドã‚ュメントã€ã§ã‚ã‚Šã€ã€Œãƒ—ãƒã‚¸ã‚§ã‚¯ãƒˆç«‹ã¡ä¸Šã’時㮠1～2週間をã‹ã‘ã¦æ›¸ãã€ã‚‚ã®ã§ã™ã€‚ 今回㯠Google ã®ã‚½ãƒ•ãƒˆã‚¦ã‚§ã‚¢ã‚¨ãƒ³ã‚¸ãƒ‹ã‚¢ã§ã‚ã‚‹ @cramforce æ°ãŒè‡ªèº«ã®ãƒ–ãƒã‚°ã§ã€ŒGoogleã§ã® Design Docsã€ã«ã¤ã„ã¦è§£èª¬ã—ã¦ã„る記事を公開ã•ã‚Œã¦ã„ãŸãŸã‚ã€æ°ã®è¨±å¯ã‚’å¾—ã¦ç¿»è¨³ã—ã¦ã„ã¾ã™ã€‚ 原文： www.industrialempathy.com 関連書ç±ï¼š Googleã®ã‚½ãƒ•ãƒˆã‚¦ã‚§ã‚¢ã‚¨ãƒ³ã‚¸ãƒ‹ã‚¢ãƒªãƒ³ã‚° ―æŒç¶šå¯èƒ½ãªãƒ—ãƒã‚°ãƒ©ãƒŸãƒ³ã‚°ã‚’支ãˆã‚‹æŠ€è¡“ã€æ–‡åŒ–ã€ãƒ—ãƒã‚»ã‚¹ オライリージャパンAmazon èªäº†ç›®å®‰ï¼š11分 (目次) デザインドã‚ュメント ã®è§£å‰–å¦ æ–‡è„ˆã¨ç¯„囲 目標ã¨éžç›®æ¨™ 実際ã®ãƒ‡ã‚¶ã‚¤ãƒ³ システ
Notion ã®ä½¿ã„æ–¹ã€ç§è¦‹ãªã© - ãƒãƒ¼ãƒ•ã‚¡ã‚¤æ—¥è¨˜
1月ãŒã¾ã‚‹ã£ã¨ã‚¹ã‚ップã•ã‚Œã¦ã„ã‚‹... ã ã¨...。 hisaichi5518.hatenablog.jp id:hisaichi5518 ã•ã‚“ãŒã“ã†ã„ã†ã“ã¨ã‚’書ã„ã¦ã„ã¦ã€éžå¸¸ã«ã‚ã‹ã‚Šã¿ãŒã‚ã£ãŸã€‚ 一方ã§ã€Notionã¨ã„ã†ãƒ„ールã¯ãã“ã¾ã§ã™ã”ã„銀ã®å¼¾ä¸¸ã§ã¯ãªã„ã¨ã„ã†ã‹ã€å¾—æ„ãªåˆ†é‡Žã¨ç„¡ç†ã«ä½¿ã£ã¦ã‚‚旨味ãŒãªã„分野/工夫ã—ãªã„ã¨ä½¿ãˆãªã„分野ãŒçµæ§‹æ¥µç«¯ã«ã‚るよã†ãªæ°—ãŒã—ã¦ã„ã¦ã€ã¨ã‚Šã‚ãˆãšåƒ•ã¯åƒ•ã§é›‘ãªæ„Ÿæƒ³ã‚’残ã—ã¦ãŠã“ã†ã¨æ€ã£ãŸã€‚ 個人ã®æ—¥è¨˜ãƒ¬ãƒ™ãƒ«ã§ã™ãŒã€‚ 今ã¾ã§ã®çµŒé¨“ã§ã€ Notion ãŒåŠ¹æžœã‚’発æ®ã™ã‚‹ç®‡æ‰€ 日記ã€æ—¥å ± 雑ã«æ›¸ã始ã‚ã‚‹ã€æ›´æ–°ã§ãã‚‹ã€ã‚³ãƒ¡ãƒ³ãƒˆã§ãã‚‹ã®ãŒã„ã„。リストã¨ã®ç›¸æ€§ã‚‚ã„ã„ timesãƒãƒ£ãƒ³ãƒãƒ«ã¿ãŸã„ãªã‚„ã¤ã¯Notionã§é‹ç”¨ã—ãŸæ–¹ãŒæœ¬å½“ã¯ã„ã„ã®ã‹ã‚‚ 物ç†çš„ãªã‚«ãƒ³ãƒãƒ³ã®ä»£ã‚ã‚Š èžé€šç„¡ç¢ã«æ›¸ãè¾¼ã‚ã‚‹ã€ãƒ¡ã‚¿æƒ…å ±ã‚’èžé€šç„¡ç¢ã«è¿½åŠ ã§ãã‚‹ã€ã¨ã„ã†ã®ã¯ã€ç‰©ç†çš„ãªçœ‹æ¿ã‚’èžé€šç„¡ç¢ã«ãƒ¬ã‚¤ã‚¢ã‚¦ãƒˆã—ãŸ
Notionã§ã®ãƒ‰ã‚ュメント管ç†ã®ä½•ãŒã¤ã‚‰ã„ã‹ - パルカワ2
Notionã§ãƒ‰ã‚ュメントを書ã„ã¦ã‚‹ã€‚ドã‚ュメントã¯æ›¸ãã€å…±æœ‰ã™ã‚‹ã€èªã‚€ãªã©ãƒ¦ãƒ¼ã‚¶ãƒ¼ãã‚Œãžã‚Œè‰²ã€…ãªã‚·ãƒŠãƒªã‚ªãŒã‚ã‚Šã€ãã®ã‚·ãƒŠãƒªã‚ªãã‚Œãžã‚Œã§ã¤ã‚‰ã¿ãŒã‚る。 Notionã«é™ã‚‰ãšã™ã¹ã¦ã®ã‚µãƒ¼ãƒ“スã¯ä½¿ã£ã¦ã„ã‚Œã°ã¤ã‚‰ã„ã¨ã“ã‚ã¯ã‚ã‚‹ã¨æ€ã£ã¦ã„ã¦ã€ã¤ã‚‰ã„ã¨ã¯ã„ãˆNotionã‹ã‚‰åˆ¥ã®ãƒ‰ã‚ュメント管ç†ã‚µãƒ¼ãƒ“スã«ä¹—ã‚Šæ›ãˆãŸã„ã¨ã„ã†æ°—æŒã¡ã¯å…¨ããªã何ãŒã¤ã‚‰ã„ã®ã‹è€ƒãˆNotionã§ãªã«ã‹å‡ºæ¥ã‚‹ã“ã¨ã¯ãªã„ã‹è€ƒãˆãŸã‚Šã€ã¤ã‚‰ã¿ã‚’共有ã™ã‚‹ã“ã¨ã§çŸ¥è¦‹ã‚’å¾—ãŸã„。 検索ãŒã¤ã‚‰ã„ フãƒãƒ¼åž‹ã¨ã‚¹ãƒˆãƒƒã‚¯åž‹ã®æƒ…å ±ãŒå…¥ã‚Šä¹±ã‚Œã‚‹ 検索をã™ã‚‹æ™‚ã¯ã‚¹ãƒˆãƒƒã‚¯åž‹ã®æƒ…å ±ã‚’æŽ¢ã™ã“ã¨ãŒå¤šã„。例ãˆã°ã€ãƒªãƒªãƒ¼ã‚¹ä½œæ¥æ‰‹é †ãƒ‰ã‚ュメントを探ã—ãŸã„ã¨ãã«ã€Œãƒªãƒªãƒ¼ã‚¹ ä½œæ¥ æ‰‹é †ã€ã§æ¤œç´¢ã™ã‚‹ã‘ã©æ—¥å ±ã‚„è°äº‹éŒ²ãªã©ã¯æ¤œç´¢ã‹ã‚‰é™¤å¤–ã—ãŸã„。 Notionã®æ¤œç´¢ã«ã¯ã€Filterã§Pageã®æŒ‡å®šãŒå‡ºæ¥ã‚‹ã®ã§ãれを駆使ã™ã‚‹ã—ã‹ãªã„。Pageã®æŒ‡å®šã‚’ã—ãŸå ´åˆã€Pageã®é…下ã¯æ¤œç´¢å¯¾
Infima | Infima
InfimaA modern styling framework for content-driven websites 🔥
TypeScript入門『サãƒã‚¤ãƒãƒ«TypeScriptã€ã€œå®Ÿå‹™ã§ä½¿ã†ãªã‚‰æœ€ä½Žé™ã“ã“ã ã‘ã¯ãŠã•ãˆã¦ãŠããŸã„ã“ã¨ã€œ
本書『サãƒã‚¤ãƒãƒ«TypeScriptã€ã¯å®Ÿå‹™ã§TypeScriptを使ã†é–‹ç™ºè€…ã®ãŸã‚ã®å…¥é–€æ›¸ã§ã™ã€‚ãã—ã¦ã€ã“ã®ãƒšãƒ¼ã‚¸ã¯TypeScriptã®ç‰¹å¾´ã‚’最速ã§æŠŠæ¡ã§ãるよã†ã€æ•°ç™¾ãƒšãƒ¼ã‚¸ã‹ã‚‰ãªã‚‹æœ¬æ›¸ã®ã‚³ãƒ³ãƒ†ãƒ³ãƒ„ã‚’ã¤ã¾ã¿é£Ÿã„ã—ãŸè¦ç´„ã§ã™ã€‚ » 本書ã¤ã„ã¦è©³ã—ã知る » ã¨ã«ã‹ã今ã™ãTypeScriptを書ã„ã¦ã¿ãŸã„ TypeScriptã¨ã¯â€‹JavaScriptã®ã‚¹ãƒ¼ãƒ‘ーセットã¨ãªã‚‹ãƒ—ãƒã‚°ãƒ©ãƒŸãƒ³ã‚°è¨€èªžã€‚é™çš„型付ã‘言語ã§ã‚ã‚Šã€ãƒ—ãƒã‚°ãƒ©ãƒ ã®æ£ã—ã•ãŒé™çš„ã«æ¤œæŸ»ã§ãる。ライブラリやIDEãªã©ã®é–‹ç™ºç’°å¢ƒãŒå……実ã—ã¦ãŠã‚Šã€å¤§ããªã‚¨ã‚³ã‚·ã‚¹ãƒ†ãƒ ã‚’æŒã£ã¦ã„る。MicrosoftãŒ2012å¹´ã«é–‹ç™ºã—ã€ã‚ªãƒ¼ãƒ—ンソースã§å…¬é–‹ã—ãŸã€‚» TypeScriptã®ç‰¹å¾´ã«ã¤ã„ã¦è©³ã—ã知る » TypeScript誕生ã®èƒŒæ™¯ã«ã¤ã„ã¦è©³ã—ã知る TypeScriptã¯JavaScriptã®ã‚¹ãƒ¼ãƒ‘ーセット​スーパーセットã¨ã¯ã€å…ƒã®è¨€èªžã¨ã®
Announcing Docusaurus 2 Beta | Docusaurus
After a lengthy alpha stage in order to ensure feature parity and quality, we are excited to officially release the first Docusaurus 2 beta. With the announcement of this beta, the team is even more confident that Docusaurus 2 is ready for mainstream adoption! Docusaurus adoption​ Don't fear the beta tag! Docusaurus 2 is widely adopted and growing fast: To get a fuller understanding of the quality
リリースã€éšœå®³æƒ…å ±ãªã©ã®ã‚µãƒ¼ãƒ“スã®ãŠçŸ¥ã‚‰ã›
最新ã®äººæ°—エントリーã®é…ä¿¡
j次ã®ãƒ–ックマーク
kå‰ã®ãƒ–ックマーク
lã‚ã¨ã§èªã‚€
eコメント一覧を開ã
oページを開ã
Eraser – Docs and Diagrams for Engineering Teams
Handbook Home
GitHub - Shopify/graphql-design-tutorial
GitHub - markdoc/markdoc: A powerful, flexible, Markdown-based authoring framework.
Notion – The all-in-one workspace for your notes, tasks, wikis, and databases.
GitHub - facebookincubator/infima: A UI framework that provides websites with the minimal CSS and JS needed to get started with building a modern responsive beautiful website
実践ADR - kawasima
{{#tags}}- {{label}}
{{/tags}}