技術文書の書き方

2022/09/02 976 users 書き方 ベストプラクティス ymmt2005 長年 メモ

howto-tech-docs.md 技術文書の書き方 このメモは、私（@ymmt2005）が長年にわたってソフトウェアプロダクト開発に関わってきて 2022年現在こうしたほうが良いと考えているベストプラクティスです。 科学的な分析等に基づくわけではない経験則であるため、今後も随時見直すことがありますし、 ここに書いてあることが常... 続きを読む

サイボウズ、エンジニア向け新人研修の資料を公開　セキュリティやモバイルアプリ開発の基礎を解説

2022/06/23 106 users サイボウズ ライセ モバイルアプリ開発 セキュリティ 基礎

サイボウズは6月23日、ITエンジニア向けの研修資料を自社ブログで公開した。同社が5月9日から20日にかけて実施した新入社員向け研修で使った資料の一部で、モバイルアプリ開発やセキュリティなどの基礎を解説している。 資料は全8種類。モバイルアプリ開発やセキュリティに加え、技術文書の書き方やソフトウェアのライセ... 続きを読む

数式がある文書作成に役立つ資料まとめ | Math Relish

2022/05/02 71 users 尺度 数式 表題 文書 文書作成

数式がある文書作成に役立つ資料まとめ なかなか上手い表題を考えるのが難しかったのと， 置かれた状況によって「役立つ」の尺度が変わる． また技術文書に限るものでもないように思ったので， 単に文書とした． なんとも正確ではないが， 何も知らずに数式を書き連ねていくよりはよいだろうということで， この表題で本... 続きを読む

Twitter、「ブラックリスト」「マスター／スレーブ」など差別を想起させるプログラム用語を変更 (1/2) - ねとらぼ

2020/07/06 14 users スレーブ Twitter 差別 とらぼ 用語

Twitterは「ブラックリスト」「ホワイトリスト」「マスター／スレーブ」など社内でソースコードや技術文書に使用している用語を、差別を連想させないものに変更すると明らかにしました。 Twitterのエンジニアリング担当公式アカウントは、「包含的な言葉は皆が所属する環境を育む上で重要な役割を演じる」とし、Twitter... 続きを読む

英語の技術文書を早く読むには - Qiita

2020/05/21 16 users Qiita Problem 英単語 英語 多く

Help us understand the problem. What is going on with this article? 英語の技術文書を早く読むにはどうしたらいいでしょうか。 頻出英単語を覚える もし「英語の技術文書を早く読みたい！」と悩んでいるとしたら，多くの場合，英語の技術文書を読むのに，英単語をほぼ全て辞書を引いている，という状況だったりする... 続きを読む

技術文書を書く際の、心技体＜改訂版＞

2020/02/06 10 users 改訂版 心技体 心構え 文書 テクニック

技術文書を書く際の、心技体＜改訂版＞ 1. 技 術 文 書 を 書 く 際 の 、 心 技 体 @icoxfog417 改訂版 2. 1 本資料は、技術文書を書くためのテクニックについて書かれた文書です。 解説は、心・技・体の3つの点から行います。 心：技術文書を書くときの心構え 技：技術文章の書き方 体：技術文章のネタを育てる方法 書... 続きを読む

Chrome拡張の高速な英語辞書ツールをつくりました

2018/09/04 1850 users Chrome拡張 webstore wtetsu https

Mouse Dictionary Chrome拡張の高速な英語辞書ツールです。 https://chrome.google.com/webstore/detail/mouse-dictionary/dnclbikcihnpjohihfcmmldgkjnebgnj とりわけ、ブラウザでよく技術文書を読む人(含自分)に最適かと思いますが、どなたでもご活用いただけます。 ソースコード https://github.com/wtetsu/mouse-dic... 続きを読む

RedPenで技術文書の誤りを指摘してもらおう - yasuhisa's blog

2017/03/27 61 users RedPen emacs yasuhisa's blog

2017 - 03 - 27 RedPenで技術文書の誤りを指摘してもらおう Emacs 自然言語の誤りを指摘してくれるRedPenを手元で使えるようにしてみました、という記事です。気が向いたので、色々書いてみました。 エンジニアであっても意外と文書を書いたり見たりする機会が多い 自然言語も機械が勝手に間違いを指摘して欲しい 自然言語もルールで分かることは機械(RedPen)に指摘してもらう 指摘... 続きを読む

機械翻訳は自動織機ではなくチェーンソーであるという話と、その帰結 - アスペ日記

2016/11/28 50 users 帰結 精度 チェーンソー 精度向上 google翻訳

先日、 機械翻訳と意味 という記事を書きましたが、それ以降も新Google翻訳の精度向上はあちこちで話題になっています *1 。 新Google翻訳を使って3700ワードの技術文書を1時間で翻訳した Google翻訳の強化でもっとも得するのは翻訳家という妙 共通して述べられているのは、「新Google翻訳の精度が 下訳に使えるレベル になった」「新Google翻訳は、翻訳家にとって大きな助けになる... 続きを読む

新Google翻訳を使って3700ワードの技術文書を1時間で翻訳した - 科学と非科学の迷宮

2016/11/24 404 users 迷宮 科学 ニューラルネットワーク Hadoop 非科学

2016 - 11 - 24 新Google翻訳を使って3700ワードの技術文書を1時間で翻訳した 新しいGoogle翻訳がニューラルネットワークに基づく機械翻訳に移行して品質が向上した 、というので早速使ってみました。 翻訳対象は HadoopのFair Schedulerに関するドキュメント です。 Fair Schedulerは、Capacity Schedulerと並ぶ Hadoop の2... 続きを読む

RedPen でわかりやすい技術文書を書こう ｜ Developers.IO

2016/03/25 178 users RedPen ソフ プログラマ Developers.IO

最近はブログを始めマニュアルや仕様書など技術文書を書く機会が多くなってきました。 技術文書はわかりやすさが重要だと思うのですが実際は書けていません。 どうしたらわかりやすい文書が書けるのだろうか？と調べていたら RedPen というツールを見つけたので早速試してみました。 RedPen とは？ RedPen とはプログラマや記者が規約に従って文書を記述するのをサポートしてくれるオープンソースのソフ... 続きを読む

東京Node学園祭2015で技術文書をソフトウェア開発する話をしてきた | Web Scratch

2015/11/07 28 users ソフトウェア Web scratch ブラ 文書 開発方法

東京Node学園祭2015に参加したきたメモです。 また、技術文書をソフトウェア開発する話という内容でブログ以上技術書以下の文書を書く場合における開発方法について話てきました。 The State of JavaScript - @domenic 皆Babelを使い始めたらそれはスタンダードじゃない可能性があるので気をつけた方がいい Custom Element Service Worker ブラ... 続きを読む

技術文書をソフトウェア開発する話 - GitBook

2015/11/07 77 users アジェンダ GitBook ソフトウェア 目的 技術書

0 Introduction 1 自己紹介 2 目的 2.1 なぜ技術文書というくくり？ 2.2 ブログ以上、技術書以下 3 アジェンダ 4 技術書 4.1 JavaScript Promiseの本 4.2 JavaScript Plugin Architecture 4.3 JavaScript Plugin Architecture 4.4 技術書に欲しい要素(Q) 4.5 技術書に欲しい要素... 続きを読む

Introduction | 技術文書をソフトウェア開発する話

2015/11/07 152 users Introduction ソフトウェア

続きを読む

自動文書検査ツールRedPenをRubyから使えるredpen-rubyを書いてみました - Fuzoku実践入門ブログ

2014/12/28 43 users RedPen Ruby Fuzoku実践入門ブログ 連載 文章

2014-12-29 自動文書検査ツールRedPenをRubyから使えるredpen-rubyを書いてみました 環境 最近、RedPenという技術文書向け校正ツールを知りました。RedPenについては、RedPenを使って技術文書を手軽に校正しよう：連載｜gihyo.jp … 技術評論社に詳しい説明があります。 本格的に文章を書くようになり、こういったツールを求めていたため、早速試してみることにし... 続きを読む

第1回　自動文書検査ツールRedPenとは？：RedPenを使って技術文書を手軽に校正しよう｜gihyo.jp … 技術評論社

2014/11/17 116 users RedPen gihyo.jp ソースプロジェクト 本連載

RedPenを使って技術文書を手軽に校正しよう 第1回　自動文書検査ツールRedPenとは？ 2014年11月17日 伊藤敬彦 この記事を読むのに必要な時間：およそ 4.5 分 1 2 はじめに 本連載ではRedPenという自動文書検査ツールの紹介とRedPenを利用した技術文書の校正方法について説明します。RedPenはオープンソースプロジェクトで，現在もゆっくりと開発が続いています。RedPe... 続きを読む

プログラマ歴13年の僕が10年後まで感謝し続けていると思う本13冊 | アライドアーキテクツ エンジニアブログ

2014/10/15 613 users アライドアーキテクツ 石田 職業プログラマ エンジニア 限界説

挨拶 お久しぶりです。ORASもうすぐ発売ですね。僕はとりあえずメガタブンネを軸にしたパーティーを組んでみるつもりです。ポケモントレーナー兼プログラマの石田です。様々な没稿を経て、こんな内容になりました。振り返ってみれば、職業プログラマとしては、もう13年になり限界説の35歳に差しかかったタイミングです。技術そのものに貪欲なタイプのエンジニアからすると読んできた技術文書の数は少いんじゃないかなと思... 続きを読む

ビックデータ時代のパイオニア！？インフォグラフィックを上手に使ったWEBサイト５選 | 88PR｜10代・20代若者向けPR/広報の株式会社ONPAJAPAN

2014/10/08 35 users パイオニア インフォグラフィック 広報 ビッグデータ時代 標識

今回は、インフォグラフィックを利用したWebサイトをご紹介します。 そもそもインフォグラフィックとは… インフォグラフィック（英語: infographics）は、情報、データ、知識を視覚的に表現したものである[1]。インフォグラフィックは情報を素早く簡単に表現したい場面で用いられ、標識、地図、報道、技術文書、教育などの形で使われている。また、計算機科学や数学、統計学においても、概念的情報を分かり... 続きを読む

PostgreSQL Deep Dive: もうひとつの「PostgreSQL Internals」技術文書が公開されました

2014/07/22 201 users PostgreSQL Internals Tweet 検証

2014年7月22日 もうひとつの「PostgreSQL Internals」技術文書が公開されました Tweet 最近、精力的にPostgreSQL関連の検証や技術情報の公開をしている日本HPさんから、「PostgreSQL Internals」という技術文書がPDFで公開されました。 日本HP ITサービス「HP OPEN SERVICES」 http://h50146.www5.hp.com... 続きを読む

天使やカイザーと呼ばれて » App Linksの技術文書を和訳してみました

2014/05/12 33 users カイザー ディープリンク App Links 天使 和訳

4月20日に行われたFacebookの開発者向けイベント「F8」にて、App Linksという新しい仕様が発表されました。これは、今までのWebでのページ間リンクのように、スマートフォンアプリ間の「ディープリンク」を可能にするための標準的な手続きになるべく発表されたものです。具体的な仕様について、さっそく和訳をしてみました。これだけ読んでもちょっと理解するのが難しいのですが、参考になると幸いです。... 続きを読む

翻訳はあなたの記事ではない - Weblog - Hail2u.net

2014/02/06 38 users 文書 ジャンル 範囲 ウェブ開発 Weblog

ウェブ開発を始めとした様々なジャンルにおいて、その有用な文書の多くは日本語以外で書かれている。幸いなことに多くの人がその翻訳を公開してくれている。僕も自分が強く興味をもった範囲で訳したりもしている。良い時代だなと思うが、その翻訳がブログの記事として公開されてしまうと、「んんっ？」と思ってしまう。 もちろんブログが技術文書のようなものを読みやすいデザインじゃないこととか、そのブログのスタイリング上の... 続きを読む

Microsoft、ゲームの没入感アップ技術「IllumiRoom」を発表 - ITmedia ニュース

2013/04/30 33 users Kinect Illumiroom プロジェクター 概念実証

米Microsoftの研究部門であるMicrosoft Researchは4月29日（現地時間）、ゲーム体験での没入感を助長するためにテレビ画面の周囲に映像を広げる“概念実証”システム「IllumiRoom（イルミルーム）」のデモ動画を公式YoTubeで公開した。同システムの概要を説明する技術文書（PDF）も公開されている。 プロジェクターとKinectを組み合わせ、テレビの周囲に画面の延長となる... 続きを読む

Google デベロッパー アカデミー — Google Developers

2012/12/03 519 users アカデミー Google Developers 従来 スキル

良質なレッスンが揃っています。Google デベロッパー アカデミー 良質なレッスンが揃っています。 Google デベロッパー アカデミーは、Google のさまざまなデベロッパー向けツールやプラットフォームに関するオンライン コースを提供するサイトです。ここに掲載しているコース教材は、従来の技術文書の枠を超え、あらゆるスキル レベルのデベロッパーがカリキュラムに沿って学習できるような充実した内... 続きを読む

MSDNオンラインにある読んでおいてほしいプロセス関連ドキュメント

2012/04/10 44 users Agile Filed under 多く 日本語

MSDNオンラインにある読んでおいてほしいプロセス関連ドキュメント 2012/04/10 | Filed under: Agile Consensus, Practice and tagged with: Agile, MSDN MSDNオンライン（MSDNマガジン含む）には、多くの技術文書が掲載されています。多くが日本語訳されています（もちろん、残念ながら翻訳できていないものもあります）。非常に... 続きを読む

学術論文の書き方のメモ - forest book

2009/07/26 654 users 学術論文 forest book メモ Writing 書き方

writing | 02:11 | 7年前の、当時、修士1回生のときに受講していた「科学技術表現」という講義のメモが出てきたので(自分用に)整理してみました。メモ書きなので講義を受講していない人には分かり難いかもしれません(^ ^;;学術論文は、技術文書とは違い、内容の良し悪しに加えて、それが論文としての「体」をなしているかが重要です。数年前のお話なので、もしかしたら、現在はその「体」が少し変わっ... 続きを読む