Build optimized websites quickly, focus on your content | Docusaurus
Build optimized websites quickly, focus on your content Powered by MDXSave time and focus on text documents. Simply write docs and blog posts with MDX, and Docusaurus builds them into static HTML files ready to be served. You can even embed React components in your Markdown thanks to MDX. Built Using ReactExtend and customize your project's layout by writing React components. Leverage the pluggabl
PagerDuty Incident Response Documentation
Home Being On-Call Before an Incident During an Incident After an Incident Crisis Response Training Additional Resources Getting Started On-Call Being On-Call Who's On-Call? Alerting Principles Before an Incident What is an Incident? Severity Levels Different Roles Call Etiquette Complex Incidents During an Incident During an Incident External Communication Guidelines Security Incident After an In
HackMD: Your Collaborative Markdown Workspace for Knowledge Sharing
Get HackMD free HackMD is my go-to thinkpad. It's been a great fit for everything from TODO lists to Ethereum devnet specs, drafting blog posts and all types of internal org docs. It's a simple yet versatile product that's a core part of all my workflows!Tim Beiko,Ethereum Foundation Accelerate innovation, foster community, and supercharge collaboration with your go-to Markdown editor. DocsTake no
How to write a good software design doc
By Angela Zhang As a software engineer, I spend a lot of time reading and writing design documents. After having gone through hundreds of these docs, I’ve seen first hand a strong correlation between good design docs and the ultimate success of the project. This article is my attempt at describing what makes a design document great. The article is split into 4 sections: Why write a design document
残業も減らせる!? 上級エンジニアになるためのDesign Doc超入門
残業も減らせる!? 上級エンジニアになるためのDesign Doc超入門：プロジェクト成功確率向上の近道とは？（3）（1/3 ページ） ITシステム開発の問題点の一つであるコミュニケーションの失敗。本連載では、これを防ぐ方法としてお勧めしたい3つのドキュメントを紹介していく。今回は、「技術視点」のドキュメントとして、2000年代以降注目されている「Design Doc」について解説します。 IT技術がビジネスに貢献していくためには、まずはシステム開発を成功させることが重要です。本連載「プロジェクト成功確率向上の近道とは？」では、システム開発を成功させるために、コミュニケーションが果たす役割の重要性と、ドキュメントによるコミュニケーションの重要性について解説してきました。 連載1回の「ドキュメントは最強のコミュニケーションツールである――Joelの機能仕様書入門」、第2回の「サンプル例に見る
OSS開発wikiツールのGROWI | 快適な情報共有を、全ての人へ
無料で使える 高機能なwikiツール マニュアルや企画書の共有、議事録の同時編集など、 チーム内での快適な情報共有と作業効率化を支えるツールです。 GROWIを始める
API Code & Client Generator | Swagger Codegen
Swagger Codegen Swagger Codegen can simplify your build process by generating server stubs and client SDKs for any API, defined with the OpenAPI (formerly known as Swagger) specification, so your team can focus better on your API’s implementation and adoption. Download SmartBear Named a Leader by Gartner® in the 2024 Magic Quadrant™ for API Management Generate Servers Remove tedious plumbing and c
YARD - A Ruby Documentation Tool
What Is YARD? YARD is a documentation generation tool for the Ruby programming language. It enables the user to generate consistent, usable documentation that can be exported to a number of formats very easily, and also supports extending for custom Ruby constructs such as custom class level definitions. Above is a highlight of the some of YARD's notable features. And of course YARD comes with muc
GitHub - OAI/OpenAPI-Specification: The OpenAPI Specification Repository
The OpenAPI Specification is a community-driven open specification within the OpenAPI Initiative, a Linux Foundation Collaborative Project. The OpenAPI Specification (OAS) defines a standard, programming language-agnostic interface description for HTTP APIs. This allows both humans and computers to discover and understand the capabilities of a service without requiring access to source code, addit
If your product isn’t documented it doesn’t exist
If I asked you to tell me about your product’s documentation right now you would probably find someone else to talk to instead. It’s not exactly the most exciting conversation for most product teams, right? Which is interesting as it’s probably one of the most important. Along with the onboarding process and customer support, documentation is the “transfer layer” of knowledge for your customers. D
RubyDoc.info: Documenting RubyGems, Stdlib, and GitHub Projects
RubyDoc.info is your source for open source Ruby library documentation, generating fresh docs for Gems and popular Git repositories. This site uses YARD to generate docs on the fly. To make your docs look better, you can check out some of YARD's killer features. We have DISQUS integration! Click the permalink (like this one) on a method to see user comments on a method page. Looking for a GitHub p
APIドキュメントを書くのが楽になるツールまとめ - Qiita
さいきんREST APIのドキュメントを書いていて、wiki使うのだるいし他に良い方法ないかな〜と調べてた時に見つけたツール群をまとめてみます。 追記: こちらも便利そうなので参考にどうぞ。 REST APIドキュメント作成ツールはapiary.ioが決定版かもしれない - Qiita swagger Swagger: A simple, open standard for describing REST APIs with JSON | Reverb for Developers デモ: Swagger UI ソースコード中にAPIの概要を書いておくと、それを元にドキュメントを自動生成してくれる。wikiやmarkdownで書くのと決定的な違いは、↓のようにドキュメント上のformからAPIコールを試すことができる点。 様々な言語のWAFに対応したライブラリも開発されてる。 Home ·
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
WebKit Web Socket design doc Authors: ukai, yuzo, tyoshino Status: Draft (as of Sept 2, 2009)
Extensions