ドキュメントを書く時に考えていること - カンムテックブログ
ソフトウェアエンジニアの summerwind です。最近は LLM が自分のふりをして代わりに仕事をしてくれるような仕組み作りを趣味にしています。 先日社内で「ドキュメントをうまく書く方法はありますか？」という質問をもらったのですが、普段ドキュメントを書く時に意識をしている要素のようなものはあるものの、それをちゃんと言語化したことがなかったため、抽象的にしか答えることができませんでした。改めて言語化をしてみるのは面白そうだなと感じたので、今回はドキュメントを書く時に考えていることをいくつか書き出してみたいと思います。 想定する読者を決める ドキュメントを書く時にまず最初にやるのは「そのドキュメントの想定する読者は誰か」についてを考えることです。よくある想定読者には次のような方々がいます。 同じチームで働くエンジニアのメンバー 同じプロジェクトで働くメンバー 全メンバー 想定する読者が決ま
質の高い技術文書を書く方法 - As a Futurist...
大学や大学院で論文の書き方を鍛え上げた人たちには遠く遠く及ばないが、僕の様なはぐれもの1でも最近は Amazon 社内で文書の質が高いと評価してもらえるまでにはなった。Software Engineer として、コードでのアウトプットはもちろん大事だけど、文書のアウトプット(およびそれによって得られた実際のアウトプット)は同じだけ重要である2。今回は自分が最近どういうところに気をつけて技術文書を書いているのか、ということについて数年後の自分が忘れてないことを確かめられる様にまとめておく。 そもそも文書とは？ 英語だと document。ここで指す(技術)文書とは、人間が読む文体で書かれた技術に関連する情報、といったものだ。具体的に言うと以下の様なものを想定している: 新しいプロジェクトの骨子を説明する資料 会議の叩き台となる 1 枚ペラ 本番環境に変更を加えるにあたっての包括的な情報や具体
アプリの起動時間の概要 | New Relic Documentation
この機械翻訳は参考用に提供されます。英語版と翻訳版に矛盾がある場合は、英語版が優先されます。詳細については、このページ を参照してください。 Android および iOS アプリケーションのパフォーマンスをより深く可視化し、クラッシュのトラブルシューティングを行うために、アプリの起動にかかる時間を監視することもできます。市場には高品質のアプリが豊富にあるため、ユーザーはアプリの起動時間に非常に敏感になり、非常に高い期待を抱いています。 アプリの起動時間を追跡する理由は何ですか? 速度はアプリのパフォーマンスの重要な部分であり、起動が遅いとユーザーは気付くでしょう。起動速度はアプリの全体的な品質を示しており、それを追跡することでアプリの応答性を評価できます。New Relic を使用すると、重要なメトリクスを追跡して、アプリのパフォーマンスを向上させることができます (コールド タイム、ホ
お悩みハンドブック
一人ひとりの悩みごとに合わせて適切な支援を案内するサービスです。あてはまる悩みにチェックをつけていくだけで200種類を超える公的支援を中心とした解決手段から利用できる可能性のある支援を提案します。
侵入型ランサムウェア攻撃を受けたら読むFAQ
ランサムウェアを用いた攻撃は、一台から数台の端末の感染被害から、業務停止を引き起こす大規模な感染被害に至るものまでさまざまです。本FAQでは、企業や組織の内部ネットワークに攻撃者が「侵入」した後、情報窃取やランサムウェアを用いたファイルの暗号化などを行う攻撃の被害に遭った場合の対応のポイントや留意点などをFAQ形式で記載します。 JPCERT/CCでは、こうした攻撃を他のランサムウェアを用いた攻撃と区別し、「侵入型ランサムウェア攻撃」と呼びます。 ネットワーク内部の複数のシステムでファイルの拡張子が変わり開封できなくなった、自組織から窃取されたとみられるファイルを暴露する投稿が行われた、または攻撃者から通知が届いたなどの状況を確認している場合、この攻撃の被害を受けている可能性があります。被害に遭われた企業や組織のCSIRTおよび情報セキュリティ担当の方は、インシデント対応を進める上での参考
プログラマーがドキュメントを書かない理由
この記事は、著者の許可を得て配信しています。 Why programmers don’t write documentation 最近ではずっとコードのドキュメンテーションに関連した記事を書いていたので、当然、私のMediumのおすすめ記事には「開発者がドキュメントを書かない本当の理由」という記事が表示されるようになりました。この記事では、ドキュメントを書くための優れたツールがないことが、ソフトウェアエンジニアが自分の作業や判断をドキュメンテーションする意欲を失わせる最大の原因について書いています。 私は普段、特定の記事を批判したりはしませんが、この記事には怒りを覚えました。このライターは図解ツールについていくつかメリットに関して述べてはいますが、全体的に誤解を招くような内容になっており、この重要な問題をより分かりにくくさせています。2つの図解ツールを比較して、どちらも不十分なツールである
社員用に作った文書校正ツールを一般公開した - gecko655のブログ
スクリーンショット これはなに 会社で「PR用の文章を人力でチェックする工数が重くて、めっちゃ残業が発生している。なんとか自動化できないか」との依頼を受け、Word等のファイルをGUIでそのままtextlintできるツールをちゃちゃっと作って社内公開しました。その結果、いい感じに社内で有効利用してもらうことができたので、外部公開に踏み切ることにしました。 github.com インストール＆設定 1. インストーラーでツールをインストールする GitHub上で配布しています。 https://github.com/gecko655/proofreading-tool/releases Mac版で「開発元が未確認のため開けません」が出た方へ https://support.apple.com/ja-jp/guide/mac-help/mh40616/mac を参考に、アプリケーションをセキュ
竹書房退職エントリ｜竹村響 Hibiki Takemura
2000年、バブルがはじけ切って就職氷河期が始まった頃。 ぼくは大学生をやっていた。 就職協定というものがあって、学生は就職活動するのは4年生、関西では4回生と呼んだけど、になってからね、と言われていたのが突然、ぼくが3回生になった途端、はい今から就職活動です！と叫ばれて、何かその真似ごとみたいなのはしたけれど、そもそも求人は少ないし、その少ない求人の中でたいしてやる気のない学生を採用するような会社はもちろんないし、結果ぼくはスムーズにニートになることに。 しかし、大学卒業直後のニートとは大学時代のゴロゴロした生活から大学を抜いたものでしかなくて、ぼくの大学生活とは本と漫画と麻雀とバンドとバイトと単位でできていたから、バンドもバイトも辞めたぼくは、仕事もないんだからバイトは続けろよとはすごく思うのだけれど上手いことできているのかどうか卒業を控えて家族経営だったバイト先が家族ごと夜逃げして潰
この書籍について · JavaScript Plugin Architecture
JavaScript Plugin Architecture この書籍はJavaScriptのライブラリやツールにおけるプラグインアーキテクチャについて見ていくことを目的としたものです。 次の形式で読むことができます。 Web版 PDF形式 ePub形式 Mobi形式 この書籍のソースコードは、次のGitHubリポジトリに公開されています。 azu/JavaScript-Plugin-Architecture: JavaScriptプラグインアーキテクチャの本 Twitterのハッシュタグは#js_plugin_book 更新情報はRSSやリリースノートから見ることができます。 はじめに JavaScriptの世界では1つの大きなライブラリよりも小さなライブラリを組み合わせていくようなスタイルが多く見られます。小さなものを組み合わせて作るためには、プラグインと呼ばれる拡張の仕組みが必要とな
HUMAN＋ 女と男のディクショナリー（改訂第二版）
Windows 10 Microsoft Edge (Chromium) 最新版 / Google Chrome 最新版 macOS 11.6 Safari 最新版 iOS 最新版 (15.6) Safari Android 11.0以上、13.0未満 Google Chrome 最新版 (OSの標準ブラウザは未対応) （一部機種は正常に動作しない場合があります） ※Apple、Apple のロゴ、Mac OS は、米国および他の国々で登録されたApple Inc.の商標です。 ※iOSは，Apple Inc.のOS名称です。IOSは，Cisco Systems, Inc.またはその関連会社の米国およびその他の国における登録商標または商標であり，ライセンスに基づき使用されています。 ※Google および Android、Google Chrome、Google Play は、米国および他
楽天広告｜OpenRTB 仕様 v3.0（日本語訳）｜Rakuten Marketing Platform navi｜RMP navi
本文書は OpenRTB 仕様 v3.0（最終版 v1.0）を日本語に翻訳したものです。 Creative Commons Attribution 3.0 の元で公開しており、ライセンスコピーの詳細はこちらをご参照ください。 最終版 v1.0 2018年11月 IAB テクノロジーラボについて IAB テクノロジーラボラトリ（テックラボ）は、標準化仕様、ソフトウェア、およびサービスを制作・提供することで、効果的かつ持続可能なグローバルデジタルメディアエコシステムの成長を促進させる非営利の研究開発団体です。 IAB テックラボは、デジタル配信事業者や広告技術会社、さらにマーケティング担当者、代理店、インタラクティブマーケティング分野に関心のある会社で構成され、モバイルおよびテレビ・デジタルビデオチャネルの有効化に重点を置くことで、透明で安全かつ効果的なサプライチェーン、よりシンプルで一貫した
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
https://www.soumu.go.jp/main_content/000811620.pdf
OSCAL - Open Security Controls Assessment Language
「義務教育で教えて欲しい」AWSの『技術的なお問い合わせに関するガイドライン』は職業を問わず全人類が読むべき
【Web広告用語解説集】プログラマティック広告の4つの取引形態を一挙公開！ | ADCAREER
ホームページ | Digital Japan 2030
https://www.jsog.or.jp/public/human_plus_dictionary/book_vol2.pdf
This project is abandoned — Abandoned project 1.0 documentation
iab VIDEO PLAYER-AD INTERFACE DEFINITION (VPAID)
iablab Video Ad Serving Template (VAST) VERSION 4.2