技術文書の書き方
howto-tech-docs.md 技術文書の書き方 このメモは、私（@ymmt2005）が長年にわたってソフトウェアプロダクト開発に関わってきて 2022年現在こうしたほうが良いと考えているベストプラクティスです。 科学的な分析等に基づくわけではない経験則であるため、今後も随時見直すことがありますし、 ここに書いてあることが常に正しいわけでもあらゆるソフトウェア開発に適するわけでもありません。 しかしながら、実務経験が豊富で、モダンな技術スタックに明るいエンジニアの経験則は一定の 役に立つのではないかと考えて記します。 技術文書とは ここでは、ソフトウェア開発で技術者が書くべき文書ということにします。 ソフトウェアエンジニアにも役割がいろいろあり、アーキテクトと independent contributor では書く文書が違うということはあるでしょうけれど、ここではごっちゃにします。
esa.io - Expertise Sharing Archives for motivated teams.
Nothing is perfect from the beginning. We want to support the growth of documents from hatching to completion. 最初から完璧なものなんてない。 esaは情報の一生を見守りたい。
WebODF
WebODF: work with your office files in the cloud, on the desktop and on your mobile WebODF is a JavaScript library that makes it easy to add Open Document Format (ODF) support to your website and to your mobile or desktop application. It uses HTML and CSS to display ODF documents. Check out our demos and see what apps and other features are available. WebODF is a Free Software project. All code is
Quip
Introducing QuipQuip helps sales teams accelerate business in real-time. Reimagine sales processes with embedded documents, live Salesforce data, and built-in collaboration. Learn More What is Quip?Quip is the easiest way for Salesforce customers to transform processes like Account Planning, Mutual Close Plans, and Qualification Notes. Standardize, automate, and embed real-time, collaborative docu
Docco
Docco is a quick-and-dirty documentation generator, written in Literate CoffeeScript. It produces an HTML document that displays your comments intermingled with your code. All prose is passed through Markdown, and code is passed through Highlight.js syntax highlighting. This page is the result of running Docco against its own source file. Install Docco with npm: sudo npm install -g docco Run it ag
Pandoc - index
If you need to convert files from one markup format into another, pandoc is your swiss-army knife. Pandoc can convert between the following formats: (← = conversion from; → = conversion to; ↔︎ = conversion from and to) Lightweight markup formats ↔︎ Markdown (including CommonMark and GitHub-flavored Markdown) ↔︎ reStructuredText → AsciiDoc ↔︎ Emacs Org-Mode ↔︎ Emacs Muse ↔︎ Textile → Markua ← txt2t
「はてな教科書」をgithub上に公開しました - Hatena Developer Blog
こんにちは、id:shiba_yu36です。 はてなのエンジニア陣によって執筆されたウェブアプリケーション作成の基本を学ぶための「はてな教科書」をgithub上に公開しましたのでお知らせします。 はてな教科書は、はてなサマーインターンでも利用されている、約1週間でウェブアプリケーションの基本を身に付けるためのものです。はてなでは日々のウェブ開発で得られたノウハウをこの教科書を継続的に盛り込みながら、インターンシップやエンジニアの新人教育などに利用しています。今回、はてな教科書をgithub上で公開することで、広くPerlを使ったウェブアプリケーション開発に興味を持ってもらえれば、と思います。 いまのところ公開されている資料は、以下の4つになります。 Perl によるオブジェクト指向プログラミング ORM によるデータベース操作 (DBIx::MoCo を使った開発) MVC によるウェブア
自宅サーバのインフラ設計書を公開します - @int128
自宅サーバのインフラ設計書を公開します。 Design paper of the home server（抜粋） 昨夜にTwitterで公開したら予想外に反響があったので、ちゃんとエントリに残すことにしました。クラックされるおそれがあるので、細かい部分は公開できないことをご了承ください。 内容はこんな感じ。 要件概要 機器仕様 ネットワーク設計 ソフトウェアスタック設計 共通基盤設計 サーバ詳細設計 上記にバックアップ設計や運用管理まわり*1を加えれば、インフラの設計書はだいたいこんな感じではないかと思います。 インフラの要件定義は難しい 一方で、インフラの要件定義は十分に標準化が進んでおらず、会社やチームによって文化がかなり違います。特に受託開発（SI）の場合は、お客様の中にインフラに詳しい人がいなくて調整に苦労することも多いと思います。費用と可用性のトレードオフの部分はなかなか伝わりづ
電子書籍、電子ドキュメントを簡単に libura（ライブラ）
libura(ライブラ)はドキュメントをもとにしたコミュニティです。使い方はこちら。 Total Documents: 86 (Pages: 1,667)
デザイン エクストリーム セミナー (DEXS) 2014 in Fukuoka
I always get excited at Easter Candy time. Mini Eggs are in stores again! Yaaay! Mini Eggs are pretty good by themselves, but there is an EVEN BETTER way to eat them. ...That's right. PUT THEM IN RICE KRISPIE SQUARES. I am basically an evil genius. If you need me, I'll be in my cave shaped like a skull on the side of a volcano.
txt2tags
About txt2tags Txt2tags is a document generator. It reads a text file with minimal markup such as **bold** and //italic// and converts it to many formats, such as: AsciiDoc Creole DocBook DokuWiki HTML LaTeX Lout Man page MoinMoin SGML Wikipedia / MediaWiki → See the complete list Created by Aurelio Jargas in 2001. Currently maintained by Florent Gallaire (v2) and Jendrik Seipp (v3). License: GPLv
ドキュメント作成に役立つ「日本語スタイルガイド」の紹介：CodeZine
はじめに 大量のドキュメントの執筆作業を複数のメンバーで行うとき、各メンバーの文章表現にどうしても差が出ます。特に、直接ユーザーの目にとまるマニュアルなどは、用語、表現を統一することがとても重要です。 大量の翻訳マニュアルを作成するSun、Microsoftでは、翻訳作業の指針とする『日本語スタイルガイド』を公開しています。本稿では、それぞれの『日本語スタイルガイド』関連情報を紹介します（ガイドラインの内容はそれぞれをダウンロードしてご覧ください）。Sunの日本語翻訳ガイドライン Sunの翻訳ガイドラインについてまとめたページがあります。Sunの日本語翻訳ガイドライン スタイルガイドをダウンロードできます。スタイルガイドのダウンロード（PDF形式） スタイルガイドは100ページにおよびますが、4ページにまとめたクイックリファレンスを、翻訳プロジェクトのReiko Saitoさんのブログ
ウノウラボ Unoh Labs: ブラウザから使用できる仕様書を書くツールまとめ
こんにちはsatoです。Windows以外の環境で仕様書を書こうと思うと、なかなか良いアプリがなかったりまします。今回はブラウザから使用できる仕様書作成ツールをまとめてみました。 1) オンラインで配置図などを描く Gliffy 配置図などをオンラインで描くことができます。また 画像への出力なども対応しています。いわゆるVisioの代わりになるツールです。 2) pdfファイルをtextに変換する PDFTextOnline pdfをtextに変換することができます。pdfの内容をスクリプトなどで切り出して、データ化するときなどに役に立ちます。他にもいろいろな変換するサイトやツールがあるのですが、ここは日本語が正常に通って見た目通りに変換できます。 3) データベースのテーブル定義などを書く WWW SQL Designer オンラインでER図などが書けます。以前miyakeさんが紹介して
HowToWriteAnEffectiveDesignDocument - 設計文書のうまい書き方
HowToWriteAnEffectiveDesignDocument - 設計文書のうまい書き方 目次 この文書について 設計文書のうまい書き方 なぜ設計文書を書くのか 良い設計とは何か 同僚の開発者に向けて書く 第 1 節に書くこと: プロジェクト/サブシステムの目的を示す 第 2 節に書くこと: 設計に使う高レベルなエンティティを定義する 第 3 節に書くこと: 個々のエンティティに関する低レベルの設計を書く 使い方 設定 モデル 相互作用 第 4 節に書くこと: 利点, 前提, リスク/懸念事項 マネージャ向けに書くこと 最後に 設計文書のうまい書き方 この文書について "How to Write an Effective Design Document" の日本語訳です. http://blog.slickedit.com/?p=43 推敲歓迎: 誤訳, タイポ, 訳語の不統一,
発表、利用、共有が簡単にできるドキュメント共有サイト！ - docune(ドキュン)
This page is used to test the proper operation of the HTTP server after it has been installed. If you can read this page it means that the HTTP server installed at this site is working properly. The fact that you are seeing this page indicates that the website you just visited is either experiencing problems or is undergoing routine maintenance. If you would like to let the administrators of this
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
GitHub - coffeedoc/codo: CoffeeScript API documentation generator. It's like YARD but for CoffeeScript!
Crocodoc
https://www.edocr.com/
http://www.textflow.com/start.html
Scribd