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
〜その意思決定を刻め〜「アーキテクチャ・デシジョン・レコード(ADR)」を利用した設計の記録 - スタディサプリ Product Team Blog
こんにちは。スタディサプリのWeb開発をやっている@highwideです。 今日は、自分の所属する"コーチングチーム"(個別指導コースや合格特訓コースの機能開発を行っています)が、最近のプロジェクトで利用した「アーキテクチャ・デシジョン・レコード」、通称「ADR」について紹介したいと思います。 アーキテクチャ・デシジョン・レコード(ADR)とは 「ADR」「アーキテクチャ・デシジョン・レコード」という概念を知ったのは、社内で行っていた「Design It! プログラマーのためのアーキテクティング入門」(以後「Design It!」)の読書会でのことでした。 www.oreilly.co.jp 最初にそのキーワードが登場する「11.2.3 必要なときだけ形式的な記述に投資する」では、「"膨大な量のドキュメントになる傾向"がある形式的なドキュメンテーション」に対比して、以下のように紹介されます
いまこそ「良い仕様書」がチームの生産性の鍵となる。ので、仕様書に含めたい 14 のポイントについてまとめました。｜Fritz | Lead Product Manager @ Mercari
いまこそ「良い仕様書」がチームの生産性の鍵となる。ので、仕様書に含めたい 14 のポイントについてまとめました。 こんにちは、フリッツ です。今回はプロダクトマネージャーの日課とも言える「仕様書」について。自分にとっては PM 業の施策実行フェーズにおいて最も重要な仕事のひとつであり、最も心躍り、最も興奮する瞬間です。 PM になってかなりの時間が経ちましたが、「仕様書」への力の入れようは減るどころか、「もっと気合を入れなければ。」と感じる一方。在宅勤務が（たぶん） IT 業界のニュースタンダードとなっていくいま、なおさら「仕様書」の重要性を訴えたい今日この頃です。 ということで、今回は ・ 良い仕様書がもたらす 5 つの効果 ・ 仕様書の重要性が増していく 2 つの理由 ・ 仕様書に含めたい 14 の項目・実戦編 ・ 仕様書作成時に心に留めたい 3 つのこと ・ 具体的な仕様書サンプル（
DocsApp
Developer Hub Perfect platform for Create and publish beautiful, powerful and cloud based developer hub. Documentation Hub Landing page for your documentation, totally customizable. Allows your product developers to discover documentation and get started in seconds. Multiple Versions Supports multiple versions of documentation. Keep old documentation for future reference and archiving purpose. Pow
Testable Examples in Go - The Go Programming Language
Introduction Godoc examples are snippets of Go code that are displayed as package documentation and that are verified by running them as tests. They can also be run by a user visiting the godoc web page for the package and clicking the associated “Run” button. Having executable documentation for a package guarantees that the information will not go out of date as the API changes. The standard libr
APIドキュメントを支える技術 2016 - ただふれたものについて書くブログ
qiita.com 1年くらい前に、APIドキュメントについて書いたけれど、最近また少し便利なことが増えてきている。 Swagger 2.0, API Blueprint が進歩してきている Swagger – The World's Most Popular Framework for APIs. もライブラリが増えたり、エディタが進化したり、clientの生成が楽になったりと、ちょっと前に比べて使いやすくなってきている。 API Blueprintも Schema セクションを記述すればバリデーションにも使える。それにDockerもだいぶ浸透して、ドキュメント生成ライブラリのaglioのDocker imageも簡単に用意できる ので、生成の手間がものすごい減っている。 Validationは、ドキュメントにJSON Schemaを定義する APIドキュメントに話を戻すと、ドキュメント
Dexy - The Most Powerful, Flexible Documentation Tool Ever
The Most Powerful, Flexible Documentation Tool Ever. Dexy is deceptively simple, letting you get started in minutes, but powerful enough to accommodate even the most sophisticated user. See Code Run Dexy helps your code to speak for itself. Show off your code with beautiful syntax highlighting. Write examples and Dexy will run them, inserting the output into any document you wish. Everything is ba
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
GitHub - k1LoW/tbls: tbls is a CI-Friendly tool to document a database, written in Go.
The AI workspace that works for you. | Notion
GitHub - swaggo/swag: Automatically generate RESTful API documentation with Swagger 2.0 for Go.
GitHub - pseudomuto/protoc-gen-doc: Documentation generator plugin for Google Protocol Buffers
こんなに使える！今どきのAPIドキュメンテーションツール
GitHub - davecheney/godoc2md: Simple translation from godoc to markdown.
What is | HelloReverb.com