タグ検索の該当結果が少ないため、タイトル検索結果を表示しています。
大学や大学院で論文の書き方を鍛え上げた人たちには遠く遠く及ばないが、僕の様なはぐれもの1でも最近は Amazon 社内で文書の質が高いと評価してもらえるまでにはなった。Software Engineer として、コードでのアウトプットはもちろん大事だけど、文書のアウトプット(およびそれによって得られた実際のアウトプット)は同じだけ重要である2。今回は自分が最近どういうところに気をつけて技術文書を書いているのか、ということについて数年後の自分が忘れてないことを確かめられる様にまとめておく。 そもそも文書とは？ 英語だと document。ここで指す(技術)文書とは、人間が読む文体で書かれた技術に関連する情報、といったものだ。具体的に言うと以下の様なものを想定している: 新しいプロジェクトの骨子を説明する資料 会議の叩き台となる 1 枚ペラ 本番環境に変更を加えるにあたっての包括的な情報や具体
技術文書の書き方
howto-tech-docs.md 技術文書の書き方 このメモは、私（@ymmt2005）が長年にわたってソフトウェアプロダクト開発に関わってきて 2022年現在こうしたほうが良いと考えているベストプラクティスです。 科学的な分析等に基づくわけではない経験則であるため、今後も随時見直すことがありますし、 ここに書いてあることが常に正しいわけでもあらゆるソフトウェア開発に適するわけでもありません。 しかしながら、実務経験が豊富で、モダンな技術スタックに明るいエンジニアの経験則は一定の 役に立つのではないかと考えて記します。 技術文書とは ここでは、ソフトウェア開発で技術者が書くべき文書ということにします。 ソフトウェアエンジニアにも役割がいろいろあり、アーキテクトと independent contributor では書く文書が違うということはあるでしょうけれど、ここではごっちゃにします。
英語の技術文書を早く読むには - Qiita
英語の技術文書を早く読むにはどうしたらいいでしょうか。 注意: この記事の目的は「技術文書について」「早く大意を読み取る」ことを目的としています。 技術文書でないもの，例えば，小説や詩には当てはまりません。 技術文書を読む場合でも，例えば，「論文を批判的に読むとき」や「扱いが悪いと故障する可能性のあるハードウェアのマニュアルを読むとき」には精読すべきですので，この記事は当てはまりません。 頻出英単語を覚える もし「英語の技術文書を早く読みたい！」と悩んでいるとしたら，多くの場合，英語の技術文書を読むのに，英単語をほぼ全て辞書を引いている，という状況だったりするのではないでしょうか？ もしそうでしたら，正攻法となる主な対策は，頻出英単語を覚えるということだと思います。 例えば英語で書かれた論文があったとします。聞いたところによると， 70%は頻出英単語トップ1500(だったと思います。うろ覚
静的サイトジェネレータ「Hugo」と技術文書公開向けテーマ「Docsy」でOSSサイトを作る | さくらのナレッジ
最近ではWebサイトを構築する際にWordPressなどのCMS（コンテンツ管理システム）を利用することが多いが、今日でも静的なHTMLファイルを使ったサイト構築には多くのメリットがある。今回は、こうしたHTMLファイルベースのサイト構築を支援するHTMLファイル生成ツール「Hugo」を紹介する。 静的ファイルでサイトを作るための支援ツール「Hugo」 コンテンツの作成や編集の容易さから、昨今ではWebサイトを構築する際にCMSを利用する例が多い。ただ、CMSを使用するにはCMS自体のインストールや設定、データベースの準備などが必要であるため、更新頻度の低いサイトやページ数の少ないサイトでは静的なHTMLファイルを使って構築したほうがコストが低くなる場合がある。 とはいえ、HTMLファイルをいちいち手動で作成するのは楽ではない。そのため、HTMLファイルを半自動生成するようなツールが数多く
技術文書の長音記号どうする？「コンピューター」と「コンピュータ」2022年現在と過去のルールについてのまとめ - Qiita
技術文書の長音記号どうする？「コンピューター」と「コンピュータ」2022年現在と過去のルールについてのまとめ日本語Englishdocumentation外来語長音 長音記号付ける？付けない？問題とは "computer" を日本語のカタカナ表記で記載したい場合、歴史的経緯などから次の2通りの表記方法がありえます。 「コンピューター」 末尾に「長音記号」があるパターン 「コンピュータ」 末尾に「長音記号」を付けないパターン 2022年現在の結論 原則的に語尾の「ー」は付ける "computer" => 「コンピューター」 迷ったら？ 原語がUSA英語で単語としてのスペル的にあるいは一般的発音慣習で伸びる場合 => 付ける "computer" => [US] kəmpjútər => 「コンピューター」 "operator" => [US] ɑ́pərèitər => 「オペレーター」
Writerside は JetBrains が提供する新しい技術文書オーサリングおよびパブリッシング環境です。
技術文書 執筆技術は誰でも学習できる！仕事で、ブログで、記事執筆で技術に関するトピックについて文章を書くことが苦手な人、どうやったらいいのかわからない人、もう一歩上を目指したい人… そんな人に向けて編集側と執筆者側で色々話していきます 人と人が気軽に会えなくなった今となっては、文章で伝えなければいけないことが増えたため、これまで以上に文章を書くということが重要になってきました。 文書を作るということは本質的には技術的な話題に限った話ではないけれども、今回は特に技術にまつわるトピックについて説明・解説したい時にどういうことを考えながら文を構築していくべきなのか、どういう文章を書くと伝わりやすいのか、そんなことを 長年WEB+DB PRESSに関わってきた稲尾編集長と、お互い技術関連記事の執筆・寄稿をしてきた牧・長谷川がいろいろ話します！
merpay Tech Talk ~伝わる技術文書の書き方~
merpay Tech Talk 、今回のテーマは 『伝わる技術文書を書く』 についてです。 テーマをTech Blogとし、執筆など文書を書くことに経験豊富なメンバーでディスカッションします。一緒に「伝わる技術文書を書く」を学びましょう！ 00:00 Opening 06:23 伝わる技術文書の書き方 by shibataさん 19:36 伝わる技術文書の書き方 by ひつじさん 34:10 伝わる技術文書の書き方 by tenntennさん 48:20 わいわいディスカッションタイム 1:04:40 Mercari Engineering Blog公開レビュー！ 1:25:30 Closing ★視聴後アンケート：https://forms.gle/oQxW512V63wYoJqYA ＜イベント関連情報＞ - イベントページ : https://mercari.connpass
こんにちは、積読の消化が追いついてねぇ…とぼやいてる、よしです。 今回は、読んだ書籍を紹介したい気持ちになりまして、紹介記事に挑戦してみました。 はじめに 紹介したい本 「技術者のためのテクニカルライティング入門講座」という書籍です。 以下、翔泳社のサイトより引用 日本では、「文書は論理的かつ簡潔に記述する」という、当たり前のテクニックを学ぶ機会があまりありません。 そこで本書では、忙しい技術者の方でも「テクニカルライティング」を通じて、相手に伝わる技術文書を効率よく書けるようになるテクニックを多数紹介していきます。 ユーザーマニュアルや障害報告書、提案書といった実務直結の文例を多数掲載しているので、すぐに業務に役立てることが可能です。 新人～中堅の技術者の方だけでなく、管理職の方も添削指導のお手本としてご利用いただける内容です。 そもそも「論理的」とはどういうことなのか？というところから
来年「グラナイト」国内投入 日本ＩＢＭは米ＩＢＭが開発した大規模言語モデル（ＬＬＭ）「グラナイト」の国内投入に合わせ、信頼性を証明するテクニカルペーパー（技術文書）を日本語で公開する。学習に用いたデータの出所や学習法を明らかにし、生成人工知能（ＡＩ）の基盤技術であるＬＬＭの活用で課題となる透明性や安全性を担保する。こうした取り組みは他に類がなく、日本語ＬＬＭのビジネス活用の本格化で問われる“信頼されるＡＩ”への試金石としても注目される。 グラナイトの英語版は米ＩＢＭが９月に発売。１２月中に学習データを増やした多言語対応版を市場投入する予定だ。日本語版は言語処理が特殊なため、多言語版とは別に日本ＩＢＭが日本語だけを切り出し、現在、追加学習をしている。２０２４年２月に日英のバイリンガル仕様として発売する見込み。 公開する日本語のテクニカルペーパーは数十ページで記述する予定。英語版と同様に、収集
英語の技術文書を早く読むには - Qiita
英語の技術文書を早く読むにはどうしたらいいでしょうか。 注意: この記事の目的は「技術文書について」「早く大意を読み取る」ことを目的としています。 技術文書でないもの，例えば，小説や詩には当てはまりません。 技術文書を読む場合でも，例えば，「論文を批判的に読むとき」や「扱いが悪いと故障する可能性のあるハードウェアのマニュアルを読むとき」には精読すべきですので，この記事は当てはまりません。 頻出英単語を覚える もし「英語の技術文書を早く読みたい！」と悩んでいるとしたら，多くの場合，英語の技術文書を読むのに，英単語をほぼ全て辞書を引いている，という状況だったりするのではないでしょうか？ もしそうでしたら，正攻法となる主な対策は，頻出英単語を覚えるということだと思います。 例えば英語で書かれた論文があったとします。聞いたところによると， 70%は頻出英単語トップ1500(だったと思います。うろ覚
SAP on AWS 技術文書
以下のガイドでは、AWS での SAP システムとソフトウェアの移行、実装、構成、運用を含む、アマゾン ウェブ サービス (AWS) クラウドでの SAP ワークロードの実行に関する詳細情報を提供しています。 AWSは SAP HANA を実行するための SAP 認定クラウドインフラストラクチャを提供しています。AWS と SAP はすべての規模の企業が AWS の SAP HANA インメモリコンピューティングプラットフォームの利点をすべて完全に理解できるよう、密に協力してきました。このセクションのガイドには、SAP HANA on AWS の移行、実装、運用に関する詳細情報が記載されています。SUSE Linux Enterprise Server (SLES) または Red Hat Enterprise Linux (RHEL) のどちらかに、SAP HANA をデプロイできます。
技術文書の読み方 - RandomThoughts
あおぞらAndroid教室でツアーとかGetting Startedとかリファレンスを読んでいけるようにする為に、 技術文書の読み方、というのを考えてみたい。 はじめに考えてる事 自分はあまり技術文書を何らかの手法に従って読んでいる訳で無く、またそうすべきともあまり思っていない。 好きに読んだらいいと思うし、自分の方法が何か特別優れていて人に伝えるべきだという気もしない。 一方で、大学とかに行ってないプログラム素人に技術文書を読ませると、 速度にも内容の消化具合にも大きく問題があり、そこには読み方の問題があるように見える。 だからプログラムを教える事の一貫として、技術文書の読み方を教える必要はあるようにも見える。 現実問題として明らかに遅さに問題があるので、なんとか出来るならしたい。 ライブラリやフレームワークや言語を学ぶのに技術文書を読む機会は多く、それら特有の特徴もいろいろあるので、
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
![中国系ハッカー、“FBIのバックドア”から米通信大手をハッキング | p2ptk[.]org](https://cdn-ak-scissors.b.st-hatena.com/image/square/44d7851311bfad4e95296b931a5ab2882dbbf1b3/height=288;version=1;width=512/https%3A%2F%2Fp2ptk.org%2Fwp-content%2Fuploads%2F2024%2F10%2Fcalea.jpg)
質の高い技術文書を書く方法 - As a Futurist...
Writerside - JetBrains が提供する新しい技術文書作成環境。
技術文書の書き方 ・ゲスト：Web+DB Press稲尾さん
技術文書を書く方に送る、書籍「技術者のためのテクニカルライティング入門講座」
“信頼されるＡＩ”への試金石…日本IBMが日本語LLMの技術文書公開へ ニュースイッチ by 日刊工業新聞社
www.lifehacker.jp
note.com/netyagi
g.co
natalie.mu
forbesjapan.com
qiita.com/readiness_