Mermaidが好きすぎるけど結局draw.ioにしがちな今日この頃ですが、ついにMermaidでAWSアーキテクチャ図が描けるようになったらしいので試してみました！ やってみた 感想としては、そこそこ複雑なものも描けそうです！ Mermaidのアーキテクチャドキュメントに飛んで、一番下のAWSアーキテクチャ図のサンプルコードに以下のコードをコピペして実行すると見ることができます mermaidコード architecture-beta service dns(logos:aws-route53)[Route53] service cdn(logos:aws-cloudfront)[CloudFront] service cert(logos:aws-certificate-manager)[ACM] service storage(logos:aws-s3)[S3] group vpc(

Deleted articles cannot be recovered. Draft of this article would be also deleted. Are you sure you want to delete this article? 要約 要件定義で生成AIを活用するポイントを整理 要件定義に特化したAIシステムのアーキテクチャを紹介 一般的なソフトウェア開発プロセスに適用できるので範囲が広い 最終的な成果物 ↓パワーポイントで作った資料をgifでエクスポートしたもの このパワーポイントの資料、 まったく人の手で修正をしていません 。完全自動の生成AIで作成された資料です。もちろん完璧なものにはならないので修正が必要なところも出てくるのですが、修正可能なpptx形式で出力されるのでパワーポイントでサクッと修正ができます。そして １からこの資料を作るのに15分もかかっ

なぜこのブログを書こうと思ったか？ 📝 とある1on1で「テックブログってどうやって書いているんですか？」と聞かれたのが発端です。 自分は数ヶ月に1記事くらいの頻度で執筆しており、その過程をあらためて言語化して社内に展開したところ、意外とポジティブな反応をもらえたのでブログにも書き起こしてみました。 皆さんの執筆の後押しになれば幸いです🙆 そもそもなぜテックブログを書くのか？ 🤔 自分の場合、以下の3つの理由でテックブログを書いています。（上から重視している順に並んでいます） 思考の整理&深掘り 文章を書く練習 対外的なアピール 理由その1: 思考の整理&深掘り 1つ目の理由としては、記事を書くことで思考を整理したい意図があります。 たとえば「こういう事象やバグを改善した」という内容のブログを書くときに、「どうやってその事象やバグを改善したのか」については書くと思います。その過程で

「コードを書くのは好きだけどドキュメントは苦手」 「ドキュメントはつい後回しにしてしまう」 エンジニアの皆さん、そんな覚えはありませんか？ 本書は、日本語ドキュメントのスペシャリストであるテクニカルライターの著者が、エンジニアが「いつ」「何のドキュメントを」「どうやって」書けばよいのかを、イチから解説します。 先生役の著者と生徒役をキャラクターにし、全編にわたってイラストを豊富に掲載。 はじめてドキュメントを書くエンジニア、またはこれまで自己流で書いてきたエンジニアが、一度読めば一生使える知識満載です。 装丁画と挿絵は、カケヒジュンさんが手がけます。 目次 ＜基礎編＞ Chapter１　良いドキュメントを効率良く書くために Chapter２　ドキュメントの読み方を理解する Chapter３　読み手とテーマを選定する Chapter４　テーマを分解する Chapter５　ドキュメントの骨組み

2024-10-05 YAPC::Hakodate 2024 https://yapcjapan.org/2024hakodate/

何か決定した事実は実装や規則の形で残っているものの、決定までの経緯をチームメンバーが覚えていない――。 この記事では、そうした組織が記憶喪失になることにどう対処していけばよいか、NTT Comの技術顧問である吉羽龍太郎 (@ryuzee) さんにふらっと相談してみたら一瞬で突破口が見つかった＆話に奥行きが出た話を共有します。 目次 目次 軽く自己紹介 事の発端 ryuzeeさんの油セール 実際に聞いてみた 新たなる概念：ADR ADRの実践：その1 何を書くか ADRの実践：その2 どこに書くか ADRの実践：その3 どう書くか 相談を受けて試しに書いてみたADR まとめ 軽く自己紹介 イノベーションセンターの小林 (@ppyv) です。 開発・検証用PCの開発に一段落つけた後、社会人学生としてたっぷり2年間学習を積んでいました。 いまはイノベーションセンターで働く社員のみなさんに、よりよ

はじめに こんにちは、株式会社カケハシでエンジニアリングマネージャーをやっている小田中（ @dora_e_m ）です。 今回は、タイトルの通り「日報を書くといいよ！」、とくに「組織のニューカマーにはオススメだよ！」という話を書きます。 日報って何? まず、日報とは何でしょうか。一般には、日々の業務内容や進捗などを報告する文書を指します。 この定義に従えば、受益者は報告される立場の上長であり、日報を作成する当の本人にはあまりメリットがありません。 私自身、ただ進捗を共有するだけの日報にはあまり意味を感じません。たとえばJiraなりTrelloなりで進捗管理している現場であれば、そのうえで進捗報告のための日報を作成することは作業の重複、情報の二重管理の発生を意味します。 ですが、日報を以下の目的で作成するようにすると、それは作成者本人にとって役立つものにできます。 毎日のふりかえり 思考プロセ

2023年6月28日に開催された「Findy×freee」さんのコラボイベントに登壇した「新人エンジニアが入っているプロジェクトにおけるREADMEの書き方」の登壇スライドです エ…

最近、『エンジニアのためのドキュメントライティング』という本を読みました。 非常にためになる内容だったので、本書であがったいくつかのポイントを私なりにまとめてみました。 また、エンジニアにとってのドキュメントは種類が多く、それぞれのニーズとそれに合わせたフォーマットも違うため、 良いドキュメントとは何か？ を一概に述べることは難しいです。 個人的には、「ほぼ知識のない人が読んでも再現できる・解決できる」ということが大事なのではないかと思っています。 そこで、本記事ではドキュメントの範囲を少し絞って、想定される読者をエンジニア寄りに考えて書いています。ご了承ください。 目次 本記事では ドキュメントを作成する前 ドキュメントを作成する時 ドキュメントを作成した後 それぞれのタイミングにおけるポイントを挙げていきます。 📑 ドキュメント作成前のポイント

どうも、株式会社ナレッジワークのざわきんといいます。 最近よく mermaid というテキストベースの図作成ツールを使っていて、ChatGPTやGitHub CopilotのようなLLMを活用したツールとめちゃくちゃ親和性が高いなと思い、居ても立っても居られないので記事にしました。 TL;DR LLM(Large Language Model)の普及により、テキストベースの図作成ツール（例：mermaid）はますます普及していくと思うので、ガンガン使っていこうぜ！という記事です。 はじめに 言葉によるコミュニケーションの難しさ 突然ですが、言葉によるコミュニケーションって難しいですよね。 頭の中にある構造を言葉だけで相手に正確に伝えることって、なかなか難しいです。 例えば、インフラ構成を説明する場合 例えば、インフラ構成を他の人に説明する場合を考えてみましょう。 ChatGPT に出力して

継続的にアウトプットするために考えていること。 対象読者を無視する 書きたいことを書けば良い。「対象読者：自分」くらいの気持ちで書く。「こんな記事誰が読むんだろう…」みたいな気持ちは捨てる。 自分にとっては些細なことでも、その情報を欲している人はたくさんいるかもしれない。公開してみないとそんなのわからん。とりあえず書いて公開する、それが一番重要。 誰に読まれるかより、誰に読まれたかを分析するほうが大事。継続して分析することで、どんな記事がどんな属性の人に読まれやすいかわかってくる。 間違ったことを書くことを恐れない 間違ったことを書いても良いというわけではないが、人間なので100%正しいことを書くことはとても難しい。労力も時間もかかる。その分情報の新鮮さはなくなっていく。 無料で読める記事なので多少の間違いは仕方ない、注意されたり気づいたら修正すれば良い。何事も諦めが肝心。 目次（アウトラ

GitHub Actionsで、ソフトウェア開発ワークフローをリポジトリの中で自動化し、カスタマイズし、実行しましょう。 CI/CDを含む好きなジョブを実行してくれるアクションを、見つけたり、作成したり、共有したり、完全にカスタマイズされたワークフロー中でアクションを組み合わせたりできます。

Java's OOM and k8s' OOM 遭遇した2つのOOMと対策 ~ Launchableでの事例 ~ / JJUG 2025 Spring

オープンソースとは何か？ Open Source Definition(オープンソースの定義) 逐条解説書 v1.0, 2024年1月22日 佐渡 秀治 Open Source guy オープンソース(Open Source)とは、米国の公益法人であるOpen Source Initiative(OSI)が策定した「オープンソースの定義」(Open Source Definition)で書かれた条件を満たすライセンス及びそのライセンスが適用されるソフトウェアのことである。このオープンソースという用語は自由ソフトウェア(Free Software)の代替として企図され、広く一般へ自由なソフトウェアを広めるためのキャンペーンのための用語として人為的に策定されたが、その後のオープンソース・ムーブメントと呼ばれる熱狂期を経て、紆余曲折ありながらも現在では世界の様々な領域においてオープンソースは当た

Deleted articles cannot be recovered. Draft of this article would be also deleted. Are you sure you want to delete this article? 概要 Design Documentと聞くと何を想像しますか？ 一般的にDesign Documentが指すのは設計書であることが多いのではないでしょうか。 設計書、簡単に説明するのであればソフトウェアを「どうやって作るの？」を説明したドキュメントです。 Googleではソフトウェアエンジニアリング文化における重要な要素として、今回お話ししていくDesign Docsと呼ばれるものがあります。 Design Docsとは？ Design Docsとは、開発者がコーディングに着手する前にソフトウェアシステムまたはアプリケーションの開発する

Dartをもっと効果的に記述してみませんか？ 本書ではEffective Dartということで、Dartで推奨されたコーディングについて紹介していきます。 Dartに少し慣れてきた方におすすめです。 DartはFlutterで使用されるプログラミング言語です。 Dartは他のプログラミング言語に比べて学習コストが低いため、初学者にもとっつきやすいものとなっております。

はじめに こんにちは。カケハシの各プロダクトを支えるプラットフォームシステムの開発チームでテックリードを担当しているkosui(@kosui_me)です。 プロダクト開発の世界では、明瞭な社内向けドキュメントを書くための方法が数多く提案されてきました。読者の中には、製品要求を明瞭にするためにPRD (Product Requirements Document、製品要求仕様書) を書き、プロジェクトの背景から全体の設計やその代案について明瞭にするためにDesign Docsを書き、アーキテクチャに関する意思決定の記録を明瞭にするためにADR(Architecture Decision Record) を書いてきた方も数多くいらっしゃると思います。 しかし、どんな素晴らしいドキュメントも、何故か更新されなくなります。新メンバーへのオンボーディングのためにインフラ構成図を検索したあなたが見つけた

はじめに 私は長い間レガシーコードと共に仕事をしてきましたが、jQueryの重要性は依然として頻繁に話題に上がるトピックの一つです。ライブラリ自体は便利なままですが、それは別の時代のニーズを完璧に満たしていました。 現在、私たちは既にES2023について話していますが、過去にjQueryがカバーしていたほとんどの機能は、すでに2015年にリリースされたES6に取り込まれています。 ES6の標準は既に広範にサポートされており、96％のレベルに達しています（出典：caniuse.com）。そのため、特に要素の選択、スタイリング、アニメーション、データの取得などの基本的なタスクについては、ライブラリの使用を見直す良いタイミングかもしれません。 以下のトピックは、いくつかの標準的なjQueryのパターンと、それに相当するバニラJavaScriptでの手法を示す参考資料として役立つと思います。 要素

2023.03.28 スキル 岩瀬義昌プロダクト 誰にでも分かりやすく、信頼できるドキュメントの存在は、プロダクト開発を円滑に進める上で不可欠だ。 2023年3月11日に発売された書籍『エンジニアのためのドキュメントライティング』（日本能率協会マネジメントセンター）を翻訳し、自身もエンジニアとしてさまざまな開発ドキュメントに触れてきた岩瀬義昌さんは、「プロダクトが育つ開発組織には、優れたドキュメントとドキュメントを尊重する文化がある」と話す。 では、プロダクト開発を成功に導く「優れたドキュメント」とはどのようなものなのか。また、そんなドキュメントが存在する組織は、そうでない組織とどんな差が生まれるのか。岩瀬さんに話を聞いた。 書籍『エンジニアのためのドキュメントライティング』翻訳者 人気ポッドキャスト『#fukabori.fm』運営者 岩瀬義昌さん（@iwashi86） 東京大学大学院修士

例として読書記録アプリをつくります！ 筆者が欲しいサービスを作ろうと思い、今回は「読書記録アプリ」をつくります。 最低限の要件は、次のように設定しました。 デモアプリの要件（読み飛ばしてOK） 読書記録アプリを作る目的 読書が苦手なエンジニアが読書記録をし、記録を共有することで、継続して技術本を読めるようになること ターゲット 新人、中堅のWebエンジニア おおまかな要件 ユーザーは新規登録することで、読書記録アプリにログインできる ユーザーは読む本を登録できる ユーザーは本を何ページ読み終えたかを記録できる ユーザーは本を読み終わったら次の本を登録できる ユーザーは他の人がどの本を読んでいるのか、また何ページ読み終えたかを閲覧できる 質問する前に... また、ChatGPTに業務で使用するコードを渡す場合、環境キーやサービスを特定できる情報を送信しないでください。入力内容が他の人に渡って