並び順

ブックマーク数

期間指定

  • から
  • まで

81 - 120 件 / 238件

新着順 人気順

ドキュメントの検索結果81 - 120 件 / 238件

  • 【サービス名変更のお知らせ】「Scrapbox」は「Helpfeel Cosense(ヘルプフィール コセンス)」に変わります

    【サービス名変更のお知らせ】「Scrapbox」は「Helpfeel Cosense(ヘルプフィール コセンス)」に変わりますナレッジはみんなで作り上げる時代へ。組織が変わるナレッジイネーブルメントツール 株式会社Helpfeel(ヘルプフィール、京都府京都市、代表取締役/CEO:洛西 一周、以下「当社」)は、ナレッジ共有サービス「Scrapbox」の名称を、本日より「Helpfeel Cosense(ヘルプフィール コセンス)」に変更したことをお知らせいたします。 サービス名の変更を機に「Helpfeel Cosense(コセンス)」は、個人の暗黙知を組織のナレッジとして共有資産にしていく文化を日本に根付かせることで、組織の新たな価値創造への貢献を目指してまいります。 ◾️サービス名変更の背景 「Scrapbox」は、手軽に知識をアウトプットできるドキュメント共有サービスです。サービスを

      【サービス名変更のお知らせ】「Scrapbox」は「Helpfeel Cosense(ヘルプフィール コセンス)」に変わります
    • 初心者大学生が作った機械学習ライブラリがGitHubでスター数300を超えた話 - Qiita

      この記事について この記事では、プログラミング初心者の大学生である(であった)私が試行錯誤しながらなんとかスター数300越えのOSSライブラリを作った過程をまとめたものです。ライブラリ自体はまだまだ発展中のためこの記事も適宜更新してく予定です。ライブラリ自体の詳細というよりも、自作OSSの認知度を上げで他の人に使ってもらうために有用そうな知見をまとめていこうと思います。 ライブラリの概要 今私が作っているのは、AIJackという、機械学習モデルがもつセキュリティ・プライバシー上の脆弱性についての各種攻撃・防御手法を実験するためのPythonツールです。既存のライブラリの多くは特定の種類の攻撃や防御に特化したものが多く、複数のタイプの攻撃・防御を組み合わせて実験するためにはいくつものライブラリを組み合わせる必要がありました。そこでAIJackでは、できる限り統一的なAPIで様々な攻撃・防御手

        初心者大学生が作った機械学習ライブラリがGitHubでスター数300を超えた話 - Qiita
      • クソコードを読ませない

        クソコードを読ませない💩 https://uit.connpass.com/event/291443/ 免責事項 「クソコードという言葉を使うな」と思った人、いると思います。 攻撃的で、解像度も荒くて、建設的でない言葉だと私は思っています。 一方で、目にすることも多い言葉であり、具体例に関してはふわりとした共通認識が持たれているのと、そういったコードに対するダメージコントロールの話なので、便宜上クソコードという言葉を使います。とあるソースコードに対してクソコードと呼ぶのはよくないですが、クソコードという概念そのものについて話すことに対しては有益だと思います。 自己紹介 sadnessOjisan JS/TS, Rust, 最近 Go, PHP マイブーム: 優光というラーメン屋 クソコードとは何か クソコードとは何でしょうか? 知りません。 インターネットミーム? https://tog

          クソコードを読ませない
        • RAGにおけるドキュメント検索精度向上について(概要編)

          はじめまして。損害保険ジャパン株式会社 DX推進部の眞方です。普段はリードエンジニアとして、新しいサービスのアーキテクチャ検討からローンチまでの作業や、新規技術を用いたアプリのプロトタイプ実装などを行なっています。 弊社では、LLM(Large Language Models)を活用したアプリケーションの開発を積極的に検討し、既に社内でいくつかのプロトタイプをローンチしています。 本記事では、その最も一般的?なユースケースの一つとも言えるRAG(Retrieval Augmented Generative)の構築において、ドキュメント検索精度の向上にどのように取り組んだ内容の概要を紹介させていただきます。実際の詳細な手法および結果については、別記事(実践編)で解説予定です。 はじめに RAGとは? この記事を読まれている方の中にはご存知の方も多いでしょうが、RAGとはRetrieval A

            RAGにおけるドキュメント検索精度向上について(概要編)
          • これをやると「言語化が苦手な人」と、意思の疎通がしやすいかもしれない。

            様々な会社に訪問していると、それなりの頻度で「言語化が苦手な人」に遭遇する。 例えばこんな具合だ。 「プロジェクトの基本要件を一つにまとめてマネジメントしたいんだけど。 例えば、一部のプロジェクトで必要なリソースを最初に一つの大きな枠組みで決めて、それを全部に使う、そんな感じ。」 「言葉にできてるじゃない」と思う方もいるかも知れない。 だが、本当に言語化の苦手な人とは、「言葉にはできているのに、その内容が、他の人にとって難解過ぎる人」なのだ。 「言葉が出てこない」 「説明しにくい」 「なんと言えばいいのか迷う」 というのは、実は「言語の苦手な人」よりもかなりマシである。 なぜならば、「言語化できていない」という認識を自分自身で持てるからだ。 それに対して、真に言語化の苦手な人は、自分自身で「言語化が苦手」と気づいていない可能性が高い。 前職にもこんな人がいたが、 「あの人、あたまが良すぎて

              これをやると「言語化が苦手な人」と、意思の疎通がしやすいかもしれない。
            • ドキュメントの限界 - orangeitems’s diary

              インフラの環境構築を行ったときに、はい、環境です、と接続情報だけ顧客に提供したところで、そのまま受け取ってくれることはない。 ドキュメントはないんですか?。 何を作ったかを示すドキュメントとセットで初めて、プロにお金を払って仕事をしてもらった気持ちになる。今でも、ドキュメントを残せ、ドキュメントがないと今どうなっているかがわからなくなる、常に更新して最新にしよう、そんな掛け声は健在である。 このドキュメント、年々複雑さが増していると思う。というのも、IT関連のソフトウェアにしろクラウドにしろ、機能は増えるばかりだからだ。かつ、設定自体は年々洗練されており、デフォルト値で動くことも多い。たくさんの設定項目があるが、設定するのはほんの一部分である。 ドキュメントに何を残すべきか。設定値全てをドキュメントに書き込もうものなら莫大な量になる。一方で変更したものは少ししかない。このギャップが激しくな

                ドキュメントの限界 - orangeitems’s diary
              • RAGを複雑な質問に強くする手法「CoA」について

                本記事では、「Chain-of-Abstraction (CoA) Reasoning」についてざっくり理解します。軽めの記事です。 株式会社ナレッジセンスでは普段の業務で、生成AIやRAGシステムを活用したサービスを開発しています。 この記事は何 この記事は、最近聞くようになった「Chain-of-Abstraction (CoA) Reasoning」の論文[1]について、日本語で簡単にまとめたものです。 今回も「そもそもRAGとは?」については、知っている前提で進みます。確認する場合は以下の記事もご参考下さい。 本題 ざっくりサマリー LLMが外部ツールを使って回答を生成するときの、回答精度を高める手法についての論文です。Metaの研究者らによって2024年1月に提案されました。「Chain-of-Abstraction (CoA)」という手法を使うメリットは、RAGに応用することで

                  RAGを複雑な質問に強くする手法「CoA」について
                • SQLite を再実装する時に役にたつドキュメント - kawasin73のブログ

                  困った時はドキュメント、どうもかわしんです。最近、諸事情で SQLite のドキュメントを読んでいます。 前回の記事 で紹介した通り SQLite を Rust で再実装しています。おかげさまで 300 を超える Github Star もいただき嬉しいです。 github.com SQLite は全ての仕様が ドキュメント にまとめられているので、そのドキュメントと本家の実装を読み比べながら実装しています。 SQLite を再実装する上で特に以下のドキュメントは役にたちます。これらだけで最小限の SQLite の実装は作れると思います。 Overview Documents > About SQLite いかに SQLite がすごいかを自慢しているドキュメント。使おうとしている人には安心を、再実装しようとする人には絶望を与えてくれます。 Programming Interfaces >

                    SQLite を再実装する時に役にたつドキュメント - kawasin73のブログ
                  • 昨年末に無料プランを大幅制限したEvernote、一部機能を無料化

                    オンラインノートサービス「Evernote」は2月14日(現地時間)、無料プランの機能制限を緩和。これまで有料プラン向けに提供していた14の機能を無料プランのユーザーにも開放した。新たに無料化された機能は以下の通り。 ・履歴のメモと復元 ・オフラインノートとノートブック ・PDF 注釈 ・PDFエクスポート ・名刺スキャン ・スプレッドシートのプレビュー機能 ・Evernote にメモをメールで送信 ・メールによるノートの共有 ・カスタム グローバル キーボード ショートカット ・モバイルの「作成」ボタンをカスタマイズ ・カスタム テンプレート ・ブール検索(AND、OR、NOTなどの演算子を使った高度な検索機能) ・位置情報の検索 ・ドキュメントと画像の検索(無料プランでは2月14日以降に追加したコンテンツのみ対応)

                      昨年末に無料プランを大幅制限したEvernote、一部機能を無料化
                    • 現場で必要になるswaggerの知識 - Qiita

                      前回は「今日から始めるswagger入門」という最低限書けるようになっておいた方が良い物をこちらの記事で解説させてもらいました 今回は、筆者が4〜5年ほど現場で見てきたswaggerを元に、現場で必要になるswaggerの知識をまとめましたので、ぜひご覧になっていただけると嬉しいです! タグ付け pathsに書かれている各APIendpointをタグ付けしてグルーピングする目的で使用されます 現場では大量のAPIendpointを設計していくこととなるので、多くなってくると大変見辛くなってきます それをグルーピングすることにより見やすくしようということです openapi: 3.0.3 info: title: test-api version: 0.0.1 # ここから tags: - name: user description: ユーザー情報 # ここまで paths: /users

                        現場で必要になるswaggerの知識 - Qiita
                      • プレスリリース駆動開発のすゝめ - LayerX エンジニアブログ

                        機械学習・データ部 / データチームの @irotoris です。こんにちは。 データチームでは社内で使うデータプラットフォームやデータマートの開発をしています。今日は弊チームの開発スタイルの中から「プレスリリース駆動開発」を紹介します。 データチームの開発スタイル データチームの開発は1週間のタイムボックスで、月曜日にバックログやプロジェクトから今週取り組むタスクを計画し、金曜にスプリントレビューを行っています。デイリーでは夕会を行っています。ベロシティの計測などは今のところできていませんが、いわゆるスクラムっぽい開発です。 その月曜朝の計画会で、まずプレスリリースを書いています。 プレスリリースとはなにか? 本来プレスリリースは新商品や新サービス、経営・人事などの企業情報を、ニュースとしてメディアに掲載する文書ですが、ここではデータチームが開発・提供する機能や改善をユーザーに伝えるため

                          プレスリリース駆動開発のすゝめ - LayerX エンジニアブログ
                        • ドキュメント執筆にもGit、ビルド、テストで再利用性や整合性を実現する「Writerside」、JetBrainsがプレビューリリース

                          Kotlinなどの開発元として知られるJetBrainsは、テクニカルドキュメントのための一連のツールを統合したドキュメントオーサリングツール「Writerside」のプレビューリリースを発表しました。 ソフトウェア開発においては、テキストで記述されたソースコードをGitでバージョン管理し、ビルドによって複数のソースコードを1つのアプリケーションへとまとめ上げ、コンパイルし、テストをして本番環境へのデプロイによりアプリケーションを公開します。 そしてこのプロセス全体を、さまざまな機能を備えたツールチェンを用いて自動化することで、ソフトウェア開発の効率を高めています。 一方で、例えばアプリケーションのチュートリアル、SDKやAPIのリファレンスドキュメントなどのドキュメントの制作過程においては、複数のファイルをフォルダにまとめ、手作業で目次のページとリンクさせることや、ソースコードのサンプル

                            ドキュメント執筆にもGit、ビルド、テストで再利用性や整合性を実現する「Writerside」、JetBrainsがプレビューリリース
                          • 意味のないアウトプットをやめる7つの方法 - paiza times

                            <この記事の著者> ばんか(bamka) - Tech Team Journal Web制作会社の会社員として働きつつ、個人でブログ/メディアライターとしても活動するパラレルワーカー。 ChatGPT等AIを公私で駆使し、ITツール・ガジェットを用いて人々の生活をより豊かにするための活用術を提供するブログも運営。 Webサイトや本で学んだ知識を、自分のものにして活用できるレベルまで引き上げるには、アウトプットが重要だと考えて、積極的にアウトプットするようにしています。 ただ、アウトプットの仕方も大事。知った知識をただSNSにコピペで貼り付けるようなやり方は、良質なアウトプットとは言えないと考えています。 そこで今回は、私が実践している「良質なアウトプット」に転換するために気を付けているポイントについてお話しします。 【目次】 1:第三者に見てもらう 2:自分の言葉で語る 3:図にまとめる

                              意味のないアウトプットをやめる7つの方法 - paiza times
                            • Design Docs を活用して効果的にプロダクト改善

                              ParisWeb 2013: Learning to Love: Crash Course in Emotional UX Design

                                Design Docs を活用して効果的にプロダクト改善
                              • 2年間の開発者ブログ運営のノウハウや意識してること - NTT Communications Engineers' Blog

                                みなさんこんにちは、イノベーションセンターの @Mahito です。普段は社内のエンジニアが働きやすくなることを目標に、コーポレートエンジニアとしての活動やエンジニア向けイベントの企画・運営をしています。 今回は、本 NTT Communications Engineers' Blog を2年間運営してきたノウハウについて共有できればと思います。先日 はてなブログ DevBlog Meetup #1 に登壇させていただく機会があり、ブログ運営に関していくつかお話しさせていただいたのですが、イベント当日に言えなかったことや言ったことの補足などをできればと思います。 目次 目次 開発者ブログのこれまでと目的 運用のノウハウ・意識していること 執筆者の確保・継続・インセンティブ設計 1. 定期的にブログの取り組みを社内に紹介することで取り組みに興味を持ってもらう 2. ニュースリリースを見て、技

                                  2年間の開発者ブログ運営のノウハウや意識してること - NTT Communications Engineers' Blog
                                • ChatGPTを使ってDDLからER図をすばやく作成する - Taste of Tech Topics

                                  最近、酢を飲むと健康に良いという話を聞き、頑張って毎日飲んでいるkonnoです。 何となくですが、朝の目覚めは良くなっている気がしますよ! 今回はデータベース設計に欠かせないER図を、ChatGPTを使ってDDL(Data Definition Language:SQLのデータ定義言語)から簡単に作成できるのか試してみたいと思います。 サンプルとなるDDLを用意 DDLのサンプルとして、以下のMySQL公式サイトで公開されている従業員データベースを利用します。 dev.mysql.com 従業員データベースに必要なファイル類一式は、上記サイトで紹介されている以下のGithubリポジトリから、 "test_db-master.zip"としてダウンロードできます。 github.com ダウンロードしたtest_db-master.zipには、従業員データベースを設定するために必要なDDLとし

                                    ChatGPTを使ってDDLからER図をすばやく作成する - Taste of Tech Topics
                                  • サバイバルTypeScriptのGPTsを作成・公開しました

                                    サバイバルTypeScriptは有志で執筆を進めているTypeScriptのOSSドキュメントです。 今回、サバイバルTypeScriptのドキュメントをベースにTypeScriptに関する質問に答えてくれるGPTsを作成・公開しました✨ この記事ではGPTs公開の背景や作成手順、現状の課題などをまとめています。 GPTs公開の背景 LLMによるドキュメント検索は近い将来(既に?)一般的になると思い、サバイバルTypeScriptでも実験的にチャットボットでの情報アクセスを作成・公開しました。 ドキュメントの情報アクセスの課題 ドキュメントが多くなると、目次やサイトマップ、サイト内検索だけでは必要な情報にアクセスするのが困難になる。 チャットボットのメリット 雑な質問でも意図を汲んで、知りたい情報にアクセスしやすい 内容を要約して説明してくれるので、手軽に情報にアクセスできる 回答の信頼性

                                      サバイバルTypeScriptのGPTsを作成・公開しました
                                    • フレームワーク「Svelte」「Solid」が話題。画期的だった仮想DOMと脱仮想DOMへの流れ

                                      フレームワーク「Svelte」「Solid」が話題。画期的だった仮想DOMと脱仮想DOMへの流れ 2024年4月8日 執筆 山内 直 有限会社 WINGSプロジェクトが運営する、テクニカル執筆コミュニティ(代表 山田祥寛)に所属するテクニカルライター。出版社を経てフリーランスとして独立。ライター、エディター、デベロッパー、講師業に従事。屋号は「たまデジ。」。著書に『Bootstrap 5 フロントエンド開発の教科書』、『作って学べるHTML+JavaScriptの基本』など。 監修 山田 祥寛 静岡県榛原町生まれ。一橋大学経済学部卒業後、NECにてシステム企画業務に携わるが、2003年4月に念願かなってフリーライターに転身。Microsoft MVP for Visual Studio and Development Technologies。執筆コミュニティ「WINGSプロジェクト」代表

                                        フレームワーク「Svelte」「Solid」が話題。画期的だった仮想DOMと脱仮想DOMへの流れ
                                      • Terraform 公式がスタイルガイドを出したので読んで要約した - Qiita

                                        3/30 に X で Terraform がトレンド入りしていて何事かと思ったら Terraform が公式ドキュメントとしてスタイルガイドを出したようです。 Terraform Style Guide いままで Terraform のスタイルに関して信頼できるドキュメントといえば Google Cloud の Terraform を使用するためのベスト プラクティス ぐらいしか知らなかったのですが、 Terraform 公式がようやく出してくれてありがたい限りです。 これでわざわざ社内の Terraform 規約を設けずとも「公式ドキュメントに従いましょう。」の一言で済みます。 ということで一通り読んだのでまとめました。 原文だと構文の簡単な使い方なども書いてありますが以下の要約ではだいたい省略しています。 詳細は原文を読んで確認してください。 要約 スタイルガイドについて コードのスタ

                                          Terraform 公式がスタイルガイドを出したので読んで要約した - Qiita
                                        • TypeScript のような構文で OpenAPI のスキーマを定義する TypeSpec

                                          import "@typespec/http"; using TypeSpec.Http; model User { id: string; name: string; birthday?: utcDateTime; address: Address; } model Address { street: string; city: string; state: string; zip: string; } @route("/users") interface Users { list(@query limit: int32, @query skip: int32): User[]; create(@body user: User): User; get(@path id: string): User; } openapi: 3.0.0 info: title: (title) versio

                                            TypeScript のような構文で OpenAPI のスキーマを定義する TypeSpec
                                          • 研究データを整理しよう・したい・せねば|まつーらとしお

                                            軽く読んだだけですが,研究者・院生にとってもそうですし,学部生でもPCで様々なものを整理するという点から役に立ちそうだと思いました。 概略版と呼べそうな動画もあるのでそちらを先に見るのもよさそうです。 全体の構成は次のとおりです。 第1章 イントロダクション 第2章 研究データ管理の方針決定 第3章 研究データの整理法 第4章 研究データの保存 第5章 研究データの公開 「イントロダクション」よりいくつかとても参考になったことを記しておきます。 フォルダ構造やファイル命名法があるこのドキュメントは例えばフォルダ組織化やファイル命名法といった普段なかなか説明しないところまで目配りされている点が大きな特徴と言えるでしょう。例えばフォルダ組織化は次のようなスライドが用意されています。 「はじめよう、研究データ管理」第3章よりどれも「当たり前」と思うかもしれませんが,徹底することはけっこう努力が必

                                              研究データを整理しよう・したい・せねば|まつーらとしお
                                            • AWS Docs GPT

                                              AI-powered Search and Chat for AWS Documentation

                                                AWS Docs GPT
                                              • 【地上の】mermaid でちょっと大きめの図を描く【星】

                                                はじめに 細かいところに PlantUML ほど融通が利かないと言われる mermaid.js ですが、逆に言えばそこまで複雑なフローでなければそこそこ描けるやんけ!ということで mermaid.js で中規模以上のフロー図を描くときに使えそうな記法などについて書いてきます。 題材 良い感じの題材が思いつかなかったので、今回は地上の星の歌詞のフロー図を mermaid.js で描いていきます。 参考↓ 準備 まずは mermaid.js でフロー図を描く際の基本です。 記載規模やお好みでどうぞ VSCode みんな大好き VSCode。拡張機能を入れることで、描きながらプレビューできたり画像出力ができます。Markdown を普段から VSCode で描いている方は下記の1を。そうでない方は2を使うと良いかと思います。 1 https://marketplace.visualstudio.

                                                  【地上の】mermaid でちょっと大きめの図を描く【星】
                                                • Web API設計時に使われ方の想定を添えると良い。けどより良いやり方を知りたい - valid,invalid

                                                  先日登壇したイベントにて、仕事で協業したモバイルエンジニアから「Web APIのドキュメントに使われ方の想定が添えられていてありがたかった」とフィードバックをもらった。 具体的にはX post (以下、tweet) に添付した画像のような感じで、Web API (以下、API) が呼び出される画面・タイミングの想定、レスポンスの使われ方の想定などをUIのスクショとともに記述する、というもの。 API設計時にこういう使われ方の想定を添えると認識揃えやすくてありがたい、とモバイルエンジニアに喜ばれました#B43_techtalk pic.twitter.com/XLB3g6fCLZ— ohbarye (@ohbarye) 2023年8月3日 他にもこんなのとか。 APIレスポンスの使われ方の想定を書いているようす このことについて思ったよりもイベント内外で反響があったので書く。 ドキュメントの

                                                    Web API設計時に使われ方の想定を添えると良い。けどより良いやり方を知りたい - valid,invalid
                                                  • エンジニアリングの時間を生み出すドキュメンテーション術 - エムスリーテックブログ

                                                    【データ基盤チーム ブログリレー 3日目】 こんにちは、エンジニアリンググループの石塚です。 趣味は筋トレです。好きなトレーニングはレッグカールです。今年2023年の1月に第一子が爆誕し、毎日子供の笑顔に癒されております。一方であまり言い訳にはしたくはないですが、事実自分自身の自由に使える時間は少なくなったなと感じております。そんな中でもトレーニングの時間は作りたいので、24時間ジムに契約して妻と娘が寝ている早朝の時間にウホウホトレーニングをしている今日この頃であります。時間のありがたみをとても感じるようになりました。 これは仕事でも同様かと思います。有限な時間の中でタスクを取捨選択して価値ある成果を上げていく事が仕事では求められます。ドキュメンテーションはその価値ある成果につながる時間を増やす一助になるかもしれません。 この記事では、ドキュメンテーションの必要性について言語化します。改め

                                                      エンジニアリングの時間を生み出すドキュメンテーション術 - エムスリーテックブログ
                                                    • git logの内容を検索する-Sと-Gの違い - $shibayu36->blog;

                                                      ずっとgit logの内容を検索するときに-Sオプションを使っていたが、実は近いオプションに-Gオプションもあり、探したい内容によっては使い分けないとダメということを初めて知った... 詳しくはhttps://git-scm.com/docs/git-logの-Sと-Gのドキュメントを見てほしい。簡単にまとめると -Sは指定した文字列の出現回数が変わるdiffがあるcommitを検索する -Gは指定した正規表現がマッチする文字列がdiffにあるcommitを検索する ドキュメントの事例部分が結構わかりやすくて、以下のようなdiffがあった場合 + return frotz(nitfol, two->ptr, 1, 0); ... - hit = frotz(nitfol, mf2.ptr, 1, 0); -S frotzで検索をかけると、frontsの出現回数は変わってないのでマッチしない

                                                        git logの内容を検索する-Sと-Gの違い - $shibayu36->blog;
                                                      • Architecture Decision Record を一年運用してみた - Qiita

                                                        この記事は、株式会社カオナビ Advent Calendar 2023の2日目です。 カオナビでは2022年9月からArchitecture Decision Record(以下ADR)を導入開始しました。本記事ではADRを導入し実際に一年間運用して見た経過をご報告しつつ、導入のポイントや注意点について紹介します。 ADRをなぜ導入したのか? まずADRについて簡単に説明すると、「アーキテクチャー設計の記録をドキュメントとして残すこと」 です。Michael Nygardのブログ記事が初出のようです。 ソフトウェア開発を行っていく間には、途中で様々な設計決定をする必要があります。例えばウェブアプリケーションであれば、データベースはMySQLにしようとか、キャッシュはRedisを使おうとかという実行環境の決定の話から、実際のプログラムの基本構造といったところまで様々です。 この設計決定は、口

                                                          Architecture Decision Record を一年運用してみた - Qiita
                                                        • 書き手の意図やコードの背景を残す方法のあれこれ −きれいなコードの次に意識すべきこと− - give IT a try

                                                          はじめに 先日、こんなエントリを書きました。 blog.jnito.com 上の記事の中で、僕は「きれいなコードだけではすんなりコードが理解できないこともある」というような話を書きました。 もちろん、ある程度の規模になってくるといくらがんばっても「すんなり」では済まない場合も増えてくるけど、それでも最初に挙げた特徴を兼ね備えたコードとそうでないコードでは、開発効率に雲泥の差が出てくる。 僕が考える「良いコード」 - give IT a try きれいなコードを書くことはいつでも大事ですが、きれいなコード「だけ」では大きなコードを理解するのは難しいです。 そこできれいなコードを書くことに加えて、僕が意識しているコードを理解しやすくする工夫について書いてみようと思います。 ただし、ここで書く内容はあくまで僕が普段心がけていることです。 現場の文化やコードの規模や歴史、開発チームのスキルや人数、

                                                            書き手の意図やコードの背景を残す方法のあれこれ −きれいなコードの次に意識すべきこと− - give IT a try
                                                          • 継続的にアウトプットするための文章術 - takanorip blog

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

                                                              継続的にアウトプットするための文章術 - takanorip blog
                                                            • RAGを使った社内情報を回答できる生成AIボットで業務効率化してみた | DevelopersIO

                                                              はじめに 新規事業部 山本です。 ChatGPT(OpenAI API)をはじめとしたAIの言語モデル(Large Language Model:以下、LLM)を使用して、チャットボットを構築するケースが増えています。通常、LLMが学習したときのデータに含まれている内容以外に関する質問には回答ができません。そのため、例えば社内システムに関するチャットボットを作成しようとしても、素のLLMでは質問に対してわからないという回答や異なる知識に基づいた回答が(当然ながら)得られてしまいます。 この問題を解決する方法として、Retrieval Augmented Generation(以下、RAG)という手法がよく使用されます。RAGでは、ユーザからの質問に回答するために必要そうな内容が書かれた文章を検索し、その文章をLLMへの入力(プロンプト)に付け加えて渡すことで、ユーザが欲しい情報に関して回答

                                                                RAGを使った社内情報を回答できる生成AIボットで業務効率化してみた | DevelopersIO
                                                              • ユーザーはドキュメントを「読みにくるけれど読んでいない」 “流し読み”しやすいドキュメント作成のポイント

                                                                インフラエンジニア向けの書籍を取り上げ、著者と出会い、楽しく本を知り、仲間を作る場所である「インフラエンジニアBooks」。ここで、『ユーザーの問題解決とプロダクトの成功を導く エンジニアのためのドキュメントライティング』の翻訳を担当した岩瀬氏が登壇。さらに、ドキュメントの具体的な書き方と、フィードバックの収集について話します。前回はこちらから。 ドキュメントは「書き始める」ことが大事 岩瀬義昌氏:3章にいきます。時間的にあと15分ぐらいしゃべっても大丈夫かな? 10分ちょっとしゃべれると思うので。(スライドが)あと70枚あるので、すごく速くいきますね(笑)。 ドラフトの執筆です。みなさんもドキュメントを書くじゃないですか。ちょっと胸に手を当てて(考えて)みると、ドキュメントを書く上で、一番難しいことは何だと思いますか? (スライドを示して)書ける人は良いんですが、最初の人が1文字目を書き

                                                                  ユーザーはドキュメントを「読みにくるけれど読んでいない」 “流し読み”しやすいドキュメント作成のポイント
                                                                • 25000行超えのAPIドキュメントを分割した話

                                                                  はじめに COUNTERWORKSバックエンドエンジニアの伊藤です。 この記事ではAPIドキュメント分割の知見を紹介します。 弊社では OpenAPI を使用したスキーマ駆動開発を採用しています。 1ファイルで管理していたところ、25000行を超える行数となり管理コストが高くなっていました。 そこで分割作業を実施したのですが、どのような方針でどう対応したかを紹介します。 1ファイルで運用するデメリット そもそもどんなデメリットが発生していたのかを記載します。 全体の構造が把握しづらく、新規参画者への認知負荷が高い 行数が多すぎるため、RubyMine など IDE やエディタのパフォーマンスが落ちる 1ファイルの内部で複数の箇所を参照しているが、それぞれCommand fで該当部分を探す必要がある。そのため、見ているコードの箇所が頻繁に飛んで情報が追いづらい 実際にやったこと 方針 チーム

                                                                    25000行超えのAPIドキュメントを分割した話
                                                                  • B+木入門:PHPで理解する データベースインデックスの仕組み/b-plus-tree-101

                                                                    PHPerKaigi 2024 の登壇資料です

                                                                      B+木入門:PHPで理解する データベースインデックスの仕組み/b-plus-tree-101
                                                                    • AWS ソリューション「AWS でのワークロード検出」で自動でシステム構成図作成してみた | DevelopersIO

                                                                      AWS ソリューション「AWS でのワークロード検出」をご存知ですか?自動でシステム構成図を作成できるソリューションです! 1. はじめに お疲れさまです。とーちです。 「AWS でのワークロード検出」というソリューションをご存知でしょうか? このソリューションは AWS 上のリソースを自動で検出し、 アーキテクチャ図を自動で生成 してくれるものになっています。使ってみて便利だと感じたので紹介させて頂こうと思います。 実は書き終わってから既に紹介ブログがあることに気づいたのですが、前回の記事から時間も経っていてソリューション名も変わっている(旧称: AWS Perspective)ので、改めて紹介ということでご了承ください。 2. 構築 早速ですが構築です。このソリューションは CloudFormation で提供されているので、CloudFormation テンプレートを使ってデプロイす

                                                                        AWS ソリューション「AWS でのワークロード検出」で自動でシステム構成図作成してみた | DevelopersIO
                                                                      • 【技術書典】「Streamlit データ可視化入門」を執筆しました。 - Qiita

                                                                        前置き こんにちは。データエンジニアの山口歩夢です! この度、技術書典16に向けて、Streamlitの入門書を執筆しました。 StreamlitはPythonで書かれたOSSのフレームワークで、こちらを使用することでWEB開発の知識がなくても非常に簡単にアプリケーションの作成をすることができます。 日本語の情報がまだ少なく、英語のドキュメントや記事で情報を集める必要がある中で、多くの方々に魅力を伝えたいと考え、今回執筆に至りました。 ※下記のリンクで電子版を販売開始しました! 謝辞 今回、こちらの技術書の作成にあたって、 Snowflake Superheroesの小宮山さん(@kommy_jp)に内容のレビューや表紙の絵の作成をしていただきました。 誠にありがとうございます 小宮山さんのSnowflakeについての著書はこちらです! コンテンツの内容 簡単にどんな内容を書いたのか解説さ

                                                                          【技術書典】「Streamlit データ可視化入門」を執筆しました。 - Qiita
                                                                        • Next.jsを初心者向けツールとして捉えている自分が、実践 Next.js を読んでみて

                                                                          Next.jsを初心者向けツールとして捉えている自分が、実践 Next.js を読んでみて2024-03-28 この記事は 実践 Next.js の書評です。 見本誌を頂いた上での記事です。(PR記事?) tl;dr App Router のメリットを理解しつつも、学習コストに割り合わないと思っている人にオススメ!ドキュメントを読めるようになるし、学習コストが下がる。 はじめに 自分はどちらかというと今の Next.js に対しては否定的な感情の割合の方が高く、仕事で困らない程度の最低限の知識しか持っていない。 しかし、なんだかんだ勉強の必要性に駆られていて、そのキャッチアップとして同書の発売を楽しみにしていた。 そんな折に @takepepe さんから見本誌をいただいたことで、この週末に読んだので書評を書きたい。 俺は今のNext.jsが好きではない 書評を書く前にポエム書かせてくれ!

                                                                            Next.jsを初心者向けツールとして捉えている自分が、実践 Next.js を読んでみて
                                                                          • Notionでプログラミングノートを作ろう!図解で作成方法を解説

                                                                            Notionでプログラミングノートを作って効率化しようNotionは、オールインワン・ワークスペースとして知られる文書管理ツールです。文書の作成や管理、共有に便利な様々な機能を持ち、情報管理の効率化に役立ちます。 Notionが持つ機能は、プログラミングノートの作成にも適しています。ページの階層構造やデータベースで情報を管理し、リンクブロックやコードブロックなどの便利なブロックにより、分かりやすく、見やすく情報をまとめることができます。 この記事では、プログラミングノートの作成に適したツールを探している方のため、Notionでプログラミングノートを作るメリットや、実際の作成方法を図解します。Notionでどのようなプログラミングノートが作れるかチェックしてみてください。 【参考】:Wiki、ドキュメント、プロジェクトがつながるコネクテッドワークスペース | Notion (ノーション)

                                                                              Notionでプログラミングノートを作ろう!図解で作成方法を解説
                                                                            • GitHub - drawdb-io/drawdb: Free, simple, and intuitive online database design tool and SQL generator.

                                                                              You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert

                                                                                GitHub - drawdb-io/drawdb: Free, simple, and intuitive online database design tool and SQL generator.
                                                                              • 優れたドキュメントは目的にかなっている “読む目的”を達成させるために書き手が意識したい「2つの品質」

                                                                                インフラエンジニア向けの書籍を取り上げ、著者と出会い、楽しく本を知り、仲間を作る場所である「インフラエンジニアBooks」。ここで、『ユーザーの問題解決とプロダクトの成功を導く エンジニアのためのドキュメントライティング』の翻訳を担当した岩瀬氏が登壇。最後に、ドキュメントの品質測定について話します。前回はこちらから。 「優れたドキュメントとは何か」を定義する 岩瀬義昌氏:最後にもう1個だけ。今日は9章までしゃべりたかったので、これをあと5分でしゃべれればゴールですね。ドキュメントの品質測定について話していきます。 (スライドを示して)品質測定、このあたりのキーワードから、きっとエンジニアであれば1度は言われたことがあるんじゃないかという言葉はこれです。 「計測できないものは改善できない」という言葉があります。これはいろいろな引用元があるので(スライドの)後ろに画像を出していますが、計測した

                                                                                  優れたドキュメントは目的にかなっている “読む目的”を達成させるために書き手が意識したい「2つの品質」
                                                                                • E2Eテストの運用を属人化しないための3つの取り組み - ANDPAD Tech Blog

                                                                                  はじめに こんにちは。QCの佐藤です。 月日が経つのは早いもので、QCメンバーも増え、多くのメンバーがブログを書いてくださっており嬉しい限りです😊*1 ANDPADで韻を踏む - ANDPAD Tech Blog アンドパッドラップの作り方 - ANDPAD Tech Blog QAがGoで始めるテストデータ作成の自動化 - ANDPAD Tech Blog ANDPADのQualityControlを紹介します!2023 - ANDPAD Tech Blog 私がブログを書いたのはもう2年前...(徐々に間隔が長くなっている...) 今回は私の担当しているプロジェクトでの、E2Eテスト管理・運用方法についてお話します。 以下のような課題ってE2Eテストあるあるですよね (´;ω;`) E2Eテストの運用が属人化してしまっている... むか~しに作ってからはただ回しているだけ... テス

                                                                                    E2Eテストの運用を属人化しないための3つの取り組み - ANDPAD Tech Blog