HTTP — 日本語訳
~HTTPを定義する各種~文書 ~HTTPは、分散型の協調的な~hypertext情報~system用の，~statelessな応用~levelの~protocolである。 ◎ The Hypertext Transfer Protocol (HTTP) is a stateless application-level protocol for distributed, collaborative, hypertext information systems. ~HTTPは、以下に挙げる［ `~IETF＠https://ietf.org/$ ~RFC, `IANA＠https://www.iana.org/$ ~registry ］により定義される。 ◎ HTTP is defined by these IETF RFCs and IANA registries. 【 以下における各項の先
📄 HTTP Documentation
📄 HTTP Documentation HTTP is defined by these IETF RFCs and IANA registries. Core Specifications The “core” semantics of the HTTP protocol are defined by: RFC 9110: HTTP Semantics RFC 9111: HTTP Caching Those semantics are expressed “on the wire” in three ways: RFC 9112: HTTP/1.1 RFC 9113: HTTP/2 RFC 9114: HTTP/3 Later versions of HTTP offer field compression: RFC 7541: HPACK Header Compression f
顧客との関係を傷付けないトラブル報告書を書くには
エンジニアの皆さんは、業務でさまざまな報告書を作成されていることと思います。エンジニアの業務で必要になる報告書は、大きく2種類に分けられます。 1つ目は、書式が決まっていて、定期的に作成する報告書です。定期報告書と呼ぶこともあります。進ちょく報告書や日報、週報、月報などが例として挙げられます。 もう1つは、不定期に発生するイベントについて記述する報告書です。この種の報告書は、書式が決まっていないものです。例としてはトラブル報告書（または障害報告書、問題対応報告書など）や、製品・技術などの調査報告書といったものが挙げられます。 これら2種類のうち、トラブルの種になりやすいのは、後者の「イベントについて記述する報告書」です。今回は、報告書の中でも特に細心の注意を払わなければならない、顧客向けのトラブル報告書（障害報告書、問題対応報告書）を作成するときに注意すべきポイントを説明します。 報告書を
読みやすいREADMEを書く | Yakst
いくつかのオープンソースプロジェクトを公開している筆者からの、読みやすくユーザーにやさしいREADMEを書くためのアドバイス。 この記事は、Rowan Manning氏による「Writing a Friendly README」(2016/3/14)を翻訳したものです。 あなたのプロジェクトのREADMEは、かなり重要です。そこはプロジェクトに初めて来た人が大抵最初に見るであろう場所であり、唯一のドキュメントであることもよくあります。あなたのオープンソースプロジェクトにとってのREADMEは、企業にとってのウェブサイトのようなものです。ウェブサイトはユーザーエクスペリエンスの注目を集めるところですが、READMEがユーザー観点で考えられることはほとんどありません。 この記事では、分かりやすいREADMEを書くために役立ち、開発者(ユーザー)の要求に見合い、開発者がプロジェクトを初めて見たの
gitbookで設計書を作成したら最高だった話 - フォトシンス エンジニアブログ
こんにちは。Akerunエンジニアの @ishturk です。 Akerun Advent Calendarの記事です。 今日は設計書の話です。 設計書をどんなツールで書くかは、僕らソフトウェアエンジニアの尽きない悩み（楽しみ）ですね。 最近はまったツールが最高に良かったので紹介させてください。 僕のツールに求める要件は以下です。 編集がカジュアルにできる UMLが書ける。あとから編集できる（画像での貼付けは編集できないのでNG） バージョンの管理ができる 好きになれる（重要） 変遷と pros/cons MS Word pros 良くも悪くもスタンダードなツールですね。 だれでも編集できるのが強みです。 Visioと組み合わせれば、UMLも後から編集可能です cons Visioは標準にするには少々値が張ります。 バイナリ形式なのでバージョン管理はしづらいです。 ページが増えたり画像を貼
AsciiDocによる継続的ドキュメント開発〜１．インストールと基本的な使い方 - dackdive's blog
はじめに ドキュメントを書くための言語としておそらく今一番ポピュラーなのは Markdown だと思いますが、 かっちりした仕様書やユーザーマニュアルなど、より本格的なドキュメント作成にはやや機能不足と感じることがあります。 私も以前、ドキュメントを Gitbook で作れないか検討したことがあったんですが 表を書くのがめんどくさかったり、図のキャプションなどに対応していなかったことから断念しました。 そこで、今回は Markdown よりも表現力の高い言語として知られる AsciiDoc を試してみます。 AsciiDoc は O'reilly でも採用されているほか、Pro Git や JavaScript Promise の本 などの非常に完成度の高い技術ドキュメントが AsciiDoc で書かれています。 （参考記事） ・テクニカルライティングの未来を先取り ー Asciidoc
RedPen
RedPen is a proofreading tool to help writers or programmers who write technical documents or manuals that need to adhere to a writing standard. RedPen automates the verifications of input documents written in natural languages — NOT computer languages such as C++ or Java. RedPen はプログラマや記者が規約にしたがって文書（マニュアルやソフトウェアドキュメント）を記述しているか検査します。 RedPen は自然言語で記述された入力文書のチェックを自動化します。 Customizable 柔軟な設定 RedPen is
TERASOLUNA Server Framework for Java (5.x) Development Guideline — TERASOLUNA Server Framework for Java (5.x) Development Guideline 5.0.0.RELEASE documentation
TERASOLUNA Server Framework for Java (5.x) Development Guideline¶
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 ·
Home
Come on in! Exhibits are open Wednesday–Sunday, 10 a.m. to 5 p.m. Buy Tickets CHM has something for everyone, from docent-led tours to demonstrations to self-guided visits. Learn Photoshop from the pros, experience the sights and sounds of classic computing, try your hand at coding, and discover why computer history is more than 2,000 years old. Discover all this and more in CHM’s onsite and onlin
Emacsで様々なプログラム言語のDocsetを選べるhelm-dash.elを試す - Web学び
2014年 1月 23日 Toni Reinaさんの helm-dash.el の紹介です。Emacs Lispのライブラリであるdash.elとはまったくの別物です。 複数のプログラミング言語やフレームワークの関数の説明などをEmacs helmのインターフェースで選べるようになり、デフォルトのブラウザで詳細を開くことができます。 最近MacOSX版のEmacsにも対応したみたいなので使い方を書き残しておきます (設定は現時点ものであり、変更になる可能性があります)。 GitHubからclone、またはelpaやel-getから入手します。 helm-dash.el 私はdocsetはDropboxには置かないようにしました。一括インストール方法は後述。 (require 'esqlite) ;; https://github.com/mhayashi1120/Emacs-esqlite
UMLet - Free UML Tools for fast UML diagrams
UMLet 15.1 Free UML Tool for Fast UML Diagrams UMLet is a free, open-source UML tool with a simple user interface: draw UML diagrams fast, create sequence and activity diagrams from plain text, share via exports to eps, pdf, jpg, svg, and clipboard, and develop new, custom UML elements. Find below the full-featured UMLet as stand-alone app for Windows, macOS, and Linux, or as Eclipse plugin. It is
Sphinx-Users.jp :: ドキュメンテーションツール スフィンクス Sphinx-users.jp
Sphinx-Users.jp¶ Sphinx-Users.jp(略称#sphinxjp)は、美しいドキュメントを簡単に生成することができるドキュメンテーションツール、 Sphinx （スフィンクス）の普及を主眼としたコミュニティです。SphinxはPythonの公式ドキュメントだけでなく、このSphinx-Users.jpのサイトも含め多くのマニュアルやサイトで使用されており、詳細を Sphinxの歴史で紹介しています。 Sphinx-Users.jp は日本の Sphinx コミュニティです。 Sphinx-Users.jp では、日本で散らばっているSphinx関連情報を集めて、Webサイト、イベントを通じてSphinx情報を発信します。 slack のコミュニケーションや勉強会の開催などを通じて、ドキュメントをパワーアップしたい人、ドキュメントや翻訳で苦労している人、Sphinxの
ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会
システム開発や保守、運用の現場においてドキュメントは必須のものです。 しかし、ドキュメントの作成・維持には多くのパワーがかかるため、ドキュ メントが存在しない、資料が古いままになっているなどといった現状を多く 耳にします。 本勉強会ではこれらのドキュメントでよく利用される「図」にフォーカスし、 みるみるうちに図を作成できる「blockdiag」をご紹介します。 「blockdiag」はシンプルなテキスト記述からブロック図、ネットワーク図などの 画像ファイルを出力可能なオープンソースの画像生成ツールです。書き やすさ、メンテナンスしやすさを中心にデザインされており、図を作るのに 配置や並べ替えに苦労する必要はありません。 blockdiagのサンプルはこちら このような特徴を持つ「blockdiag」と、シンプルな記述でドキュメントを作成 するツール「Sphinx」を組み合わせることによって
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
継続的ドキュメント管理 - IT-TERA
CartoCSS — carto documentation
textlint · The pluggable linting tool for text and markdown
TheNEXUS
plantuml
Overview — Bazaarのドキュメント