オープンソースドキュメント翻訳プラットフォームとしての GitHub (React 日本語ドキュメントの例)
はじめに ひょんなことから React 公式ドキュメント日本語版のメンテナをやらせていただいています smikitky です。 この記事は、React 公式ドキュメントの翻訳作業が GitHub ベースでどのように行われているのかを解説したものです。ドキュメントの翻訳には色々な方法がありますが、React の現アプローチは非常に上手く行っていると個人的に考えています。部分的には似たアプローチを説明している既存記事も探せばありますが、少し詳しめに書くことで事前の不安を取り除き、「思ったより簡単そうだから、自分もあのライブラリのドキュメント翻訳をやってオープンソースに貢献してみよう」と思えるようになることを目標にしています。 想定読者は Git、GitHub、Markdown（ないし類似の軽量マークアップ言語）、および基本的な HTML の仕組みがわかる開発者です。何らかの静的サイトジェネレー
〜その意思決定を刻め〜「アーキテクチャ・デシジョン・レコード(ADR)」を利用した設計の記録 - スタディサプリ Product Team Blog
こんにちは。スタディサプリのWeb開発をやっている@highwideです。 今日は、自分の所属する"コーチングチーム"(個別指導コースや合格特訓コースの機能開発を行っています)が、最近のプロジェクトで利用した「アーキテクチャ・デシジョン・レコード」、通称「ADR」について紹介したいと思います。 アーキテクチャ・デシジョン・レコード(ADR)とは 「ADR」「アーキテクチャ・デシジョン・レコード」という概念を知ったのは、社内で行っていた「Design It! プログラマーのためのアーキテクティング入門」(以後「Design It!」)の読書会でのことでした。 www.oreilly.co.jp 最初にそのキーワードが登場する「11.2.3 必要なときだけ形式的な記述に投資する」では、「"膨大な量のドキュメントになる傾向"がある形式的なドキュメンテーション」に対比して、以下のように紹介されます
Docker ドキュメント日本語化プロジェクト — Docker-docs-ja 24.0 ドキュメント
注意 このサイトは Docker 公式ドキュメントを有志で日本語に翻訳しています。各ページの情報が古い可能性があるため、最新のドキュメントは https://docs.docker.com/ をご覧ください。 DISCLAIMER: This site is translating the official Docker documentation into Japanese by volunteers. As the information on each page may be outdated, please refer to the latest documentation at https://docs.docker.com/ . 注意 Docker v24.0.x (current) 向けにドキュメントの改訂作業中です(2023年7月現在)。一部古い場合がありますので、ご注意く
システム構成図をテキストで
Gigazineさんでdrawthe.netを取り上げていたので紹介です。使い方はGigazineさんのほうが丁寧なので、気になる方はチェックしてみてください。（2020年12月1日、追記） drawthe.netとは cidrblock/drawthe.netは複雑なネットワーク図も「テキストで書いてブラウザ上でSVGレンダリングできるようにしよう」というコンセプトのもと開発されたツールです。下図のように複雑な構成図も精度高く描くことができます。 拡大してみると情報量が多いこと、またいかに整っているかがわかると思います。 デモサイトも用意されているので、サクッと試したい場合はコチラが便利です。コードはGitHubで公開されています。更新が2017年末で止まってしまっているのが玉に瑕ですが、十分な性能を発揮してくれます。 drawthe.netを使いたい理由 美しい構成図といえばInter
「テストコードにはWhat,ソースコードにはHow,そして，ドキュメントにはWhyを書くんだよ！」 : ξ*゜ー゜)ξ { 遅レス。 - 日本Rubyカンファレンス 臨時打ち上げ
もう声が出ませんでした。終新幹線をスルーしてもう一泊。 テストについて熱く テストコードにはWhat, ソースコードにはHow, そして，ドキュメントにはWhyを書くんだよ！ by 角谷さん。角谷さんの LightningTalk が聞けるのは(ここ数ヶ月の間は)「- 夏イベント」だけ！ 追記： 個人的には、この説明がテストコードから始まっているのもポイントだと思う。 アサマシ！ APIドキュメントはテストコードにあるべきでは？ by すとうさん 嫁に隠れてバカエロ 嫁のコンピューターの hosts で自サイトを適当な IP にしておく。 キーボードショートカットで別アプリで隠す準備をしつつ、対面でサーフしてるらしい ハルヒは流石に寝静まってから見てるらしい。 SeasarはJava界の救世主
Google エンジニアリング・プラクティス ドキュメント
Google エンジニアリング・プラクティス ドキュメント このページは、Google Engineering Practices Documentation の非公式な日本語翻訳です。元のドキュメントは、クリエイティブ・コモンズの「CC-By 3.0」ライセンスで公開されています。 Google には、あらゆる言語・あらゆるプロジェクトをカバーする一般化されたエンジニアリング・プラクティスが数多く存在します。こうしたドキュメントは、私たちが長年に渡って開発してきたさまざまなベストプラクティスの経験が集結したものとなっています。オープンソース・プロジェクトやその他の組織でも、こうした知識から恩恵を受けられるかもしれません。そのため、私たちは可能な限り、この知識を公開するように努めています。 現在、以下のドキュメントが公開されています。 Google コードレビューガイドライン (Googl
ブロック図生成ツール blockdiag — blockdiag 1.0 ドキュメント
ブロック図生成ツール blockdiag¶ blockdiag シリーズはシンプルなテキストからブロック図などの画像を生成する画像生成ツール群です。 blockdiag を用いると以下のような図が簡単に生成できます。 blockdiag の主な機能: 数種類の図に対応 ブロック図 (blockdiag コマンド) シーケンス図 (seqdiag コマンド) アクティビティ図 (actdiag コマンド) 論理ネットワーク図 (nwdiag コマンド) テキストベースの定義ファイルから画像ファイルを生成 (graphviz 風の文法を採用) 定義にあわせて図の配置を自動的に決定 (自動レイアウト) Sphinx, Trac, Redmine, 各種 Wiki エンジン等、多様なシステムへの画像埋め込みに対応 Enjoy documentation with blockdiag !
Docker ドキュメント日本語化プロジェクト — Docker-docs-ja 24.0 ドキュメント
注意 このサイトは Docker 公式ドキュメントを有志で日本語に翻訳しています。各ページの情報が古い可能性があるため、最新のドキュメントは https://docs.docker.com/ をご覧ください。 DISCLAIMER: This site is translating the official Docker documentation into Japanese by volunteers. As the information on each page may be outdated, please refer to the latest documentation at https://docs.docker.com/ . 注意 Docker v24.0.x (current) 向けにドキュメントの改訂作業中です(2023年7月現在)。一部古い場合がありますので、ご注意く
マイクロソフトの日本語表記ルール | 日経 xTECH（クロステック）
昔から思うのですが、マイクロソフトの日本語表記ルールは実に奇妙です。現在は、広く一般に公開されていますので、ぜひ目を通してみてください。 まず、マイクロソフトは世界中の多くの言語をサポートすることを強調しています。そのためのポータルサイトも設置されています。しかし、そのサイトの日本語名は「マイクロソフト ランゲージ ポータル」。「ランゲージ」という言葉は決して一般的な用語ではありません。「ポータル」が一般に通じるかどうかも怪しいものです。各国の言語を尊重しているようにはとても思えません。 ちなみに、フランス語サイトもスペイン語サイトも、最初のパラグラフに登場する英語は「Microsoft」だけです。なお、かなに相当する文字を持つ言語はどうだろうと思い、韓国語サイトを開いてみましたがハングルは読めませんでした。 次に、各言語のスタイルガイドを見てみましょう。一覧の中で、私が知っている言語は日
overlasting.net
overlasting.net 2020 Copyright. All Rights Reserved. The Sponsored Listings displayed above are served automatically by a third party. Neither the service provider nor the domain owner maintain any relationship with the advertisers. In case of trademark issues please contact the domain owner directly (contact information can be found in whois). Privacy Policy
Python 和訳ドキュメント
過去のバージョン 翻訳プロジェクトでは，バージョン 2.3.5 の標準ドキュメントの訳出を終えて います．これらのドキュメントは実質的にメンテナンスを停止しています． (古いバージョンのドキュメントをメンテナンスしたいという方は，ぜひ 御協力ください！)
文章の作り方 - 伝わるデザイン 研究発表のユニバーサルデザイン
研究者や研究に関わる大学生や大学院生は、一年を通じて研究室ゼミや学会などで研究成果の発表を行なわなければなりません。また、近年、科学者でない人たちに対する一般向けのプレゼンや講演（アウトリーチ活動）の機会も増えてきています。他にも、研究論文や報告書を書いたり、研究費調達のために予算申請書やプロジェクトの提案書を作成したりすることも、研究者にとって欠かせない仕事です。これらはいずれも情報を他者（研究仲間や審査員、一般市民）へ伝えようとする行為であり、正確かつ効果的な情報の発信が望まれます。しかし、自己流で資料を作成して、闇雲に情報を発信していても、スムーズに情報は伝わりません。ときには誤った情報が伝わってしまい、研究の価値を正当に評価してもらえないことさえ起こりえるのです。 情報を正確にかつスムーズに他者に伝えるためには、情報をデザインすること、つまり文章を読みやすく整えたり、図表を見やすく
ユーザを混乱させない表組みのコツ (ユーザビリティ実践メモ)
ウェブサイト制作において、多くの情報をいかに整理してユーザに伝えるかは重要なポイントの1つです。よく使われる方法として表組みがありますが、今回は実際の事例をもとにしたケーススタディを通じて、ユーザを混乱させない表組みのコツをご紹介します。 表１はよく見かける表組みの例ですが、実際にユーザの立場に立ってこの表を使用してみると、いくつかの問題点があります。 同種の情報をユーザは区別できない 表1の問題点として、 日付という同種の情報を多く掲載しているため、ユーザには各情報が何の日付を意味しているのか区別できず、分かりにくい列数が多いために、セル内に折り返しが発生し、読みにくい ことが挙げられます。 特に、1つ目の問題点は、表が縦に長い場合にユーザを混乱させる要因の一つになります。なぜなら、画面サイズに収まりきらないほど表が縦に長い場合、下にスクロールしていくと「開催日」などの項目名が画面から消
渋日記: 1日〜1週間のでOSSに貢献する方法
渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 OSC 2009 Tokyo/FallのLTで発表してきました。ACアダプタを忘れて、Windows PCで発表する予定だったのを、バッテリー持ちの良いMacBookにスイッチ。また、当日はPloneのブースで山本烈さんにアダプタをお借りしました。「電源とRGBケーブルありますよ！」とmixiを見てダイレクトメッセージを送ってくれた清水川さんともども、感謝申し上げます。 なぜかトリだったのですが、トラブルがあってその前に。タイマーが無かったのでiPod Touchの時計を表示しながら話していましたが、省電力設定がONのままだったので、ちょくちょくロックがかかってしまったのは失敗でした。今度から気をつけよう。 今回は話す内容がほぼそのままスライドになっているので補足するところは少
Overview — Sphinx v1.0 (hg) documentation
ダウンロード このドキュメントはバージョン1.0 (hg)のためのものです。まだリリースされていません。 Mercurialリポジトリのコードを利用するか、Python Package Indexにあるリリースバージョンを探してください。 疑問? 意見? Googleグループへの参加: もしくは、FreeNodeの#python-docsチャンネルへどうぞ 何か気づいたことがあれば、issue trackerを使用して通知することもできます。 Sphinxは知的で美しいドキュメントを簡単に作れるようにするツールです。Georg Brandlによって開発され、BSDライセンスのもとで公開されています。 このツールはもともと、新しいPythonのドキュメントの変換のために作られました。そして、今までに数々のPythonや、他の言語で開発されているプロジェクトに対して、すばらしいドキュメンテーシ
アジャイル開発者の習慣―acts_as_agile：第4回 ドキュメントを大切にする｜gihyo.jp … 技術評論社
ソースがドキュメントだ。バグも完全に記述されている。 ――まつもとゆきひろ[1] はじめに 本連載ではアジャイル開発を「アジャイルに開発する人たち（アジャイル開発者）が開発するからアジャイル開発」と考え、アジャイル開発者に必要なスキルを磨くための習慣を紹介しています。 これまでの3回を費して紹介した「フィードバックを重視する」「仕組みを育てる」「スケール間に連続性を築く」といった習慣は、チームによるシステム開発の現場でアジャイルにプログラムを書くことを重視したものでした。 しかし、これでは開発対象となるシステムを構成する2つの要素のうち主に1つしか説明していません。2つの要素とは、プログラムとドキュメントです。今回は、これまであまり触れてこなかった、2つの要素のうちの1つであるドキュメントに関する習慣を紹介します。 そのためにまず、アジャイル開発者にとってのドキュメントの位置づけを説明
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
GitHub - zembutsu/docs.docker.jp: Dockerドキュメント日本語化プロジェクト ,Docker Documentation Translate Project for ja-jp
https://people.allbsd.org/~hrs/N+I2005/sato-n+i.pdf
Sample Document — sphinxcontrib-rubydomain v0.1 documentation
sphinxcontrib-rubydomain