https://github.com/k1LoW/wsa-sg-8th-draft
システムの変化に追従可能でかつ理解し易いドキュメントシステムのモデル化 / Web System Architecture #8
https://github.com/k1LoW/wsa-sg-8th-draft
自民党総裁選に出馬する石破茂元幹事長の陣営は６日、国内外で人気を博している任天堂の家庭用ゲーム機「ニンテンドースイッチ」のソフト「あつまれ どうぶつの森」（あつ森）を選挙運動に活用すると発表した。街頭演説の実施が見送られる中、ゲーム空間を利用して党員らと交流を図る。 あつ森はプレーヤーが無人島で釣りや園芸、他のプレーヤーとの交流を楽しむゲーム。８日以降、石破氏をモチーフにしたキャラクター「いしばちゃん」が登場し、プレーヤー同士が共有できる「マイデザイン」という機能を使い、石破氏の「ポスター」をゲーム内に広めてもらう。 広報戦略を担当する平将明衆院議員は「政治に接したことのない人も総裁候補と直接話をできる。政治に興味を持っていない人に興味を持ってもらえれば」と語った。あつ森は海外でもヒットし、米大統領選の民主党候補、バイデン前副大統領陣営も選挙運動に使っている。
Open Developer Conferenceでの登壇資料です。 https://www.ospn.jp/odc2019/modules/eguide/event.php?eid=31 (運用設計ラボ合同会社 波田野裕一)
こんにちは、koidです。 この記事は Gunosy Advent Calendar 2021 - Adventar の25日目の記事です。 昨日の記事は aitaさんの EKSにJupyterHubを構築した - Gunosy Tech Blog でした。 ドキュメントの更新って面倒だし忘れがち ドキュメントのメンテナンスを自動化しよう コードからドキュメントを自動生成する ツールの利用によるドキュメント生成 CIによるドキュメント生成の自動化 状態からドキュメントを自動生成する ツールの利用によるドキュメント生成 CIによるドキュメント生成の自動化 まとめ ドキュメントの更新って面倒だし忘れがち 本題です。 みなさん、Pull Requestのレビュー時に、 ドキュメント・READMEも修正お願いします！ こういったコメントをした/された経験ってありませんか？ コメントをする側としても
Googleドキュメントでブログが作り放題になるWebサービス「Nocode」を使ってみた！ - paiza times
どうも、まさとらん（@0310lan）です！ 今回は、普段使っているGoogleドキュメントをブログとして使えるようにしてくれるWebサービスをご紹介します。 ブログの記事はすべてGoogleドキュメントで作成・管理できるようになっており、ボタンをクリックするだけでネット上に公開できる非常にお手軽なサービスです。 最近話題のノーコード（NoCode）でブログが作れるサービスとしても活用できるでしょう。 【 Nocode 】 ■「Nocode」の使い方 それでは、「Nocode」をどのように使えばいいのか詳しく見ていきましょう！ まずはサイトのトップページにアクセスして【GET STARTED】ボタンをクリックしてください。 Googleアカウントとの連携画面になるので、ボタンをクリックして認証をしておきます。 次に、作成するWebページのテンプレートが選択できるのですが、今回は【Blog】
ChatGPTで自前のドキュメントを利用できるプラグイン、「ChatGPT Retrieval Plugin」の概要 | DevelopersIO
2023年3月23日、OpenAI社はChatGPTでのプラグインの立ち上げを発表しました。 これにより、ChatGPTとさまざまな情報を組み合わせることができるようになり、ChatGPTが利用できるシーンはさらに多様になっていくと予想されます。 この発表と併せて、OpenAI社のGithubリポジトリで、「ChatGPT Retrieval Plugin」が公開されました。 このプラグインにより、ChatGPTで自前のドキュメントを利用する（つまり、自前のドキュメントの情報をもとにしたQ&Aなどができる）ようになるようです。 2023年3月24日現在、まだChatGPTのプラグイン自体は利用するにはWaitlistに登録して順番を待たなければいけない状態です。そのため、このプラグインをいまいま試すことはできないのですが、Github上のREADMEを読み解いて、どんなことができるかなどざ
インフラエンジニア向けの書籍を取り上げ、著者と出会い、楽しく本を知り、仲間を作る場所である「インフラエンジニアBooks」。ここで、『ユーザーの問題解決とプロダクトの成功を導く エンジニアのためのドキュメントライティング』の翻訳を担当した岩瀬氏が登壇。最後に、ドキュメントの品質測定について話します。前回はこちらから。 「優れたドキュメントとは何か」を定義する 岩瀬義昌氏：最後にもう1個だけ。今日は9章までしゃべりたかったので、これをあと5分でしゃべれればゴールですね。ドキュメントの品質測定について話していきます。 （スライドを示して）品質測定、このあたりのキーワードから、きっとエンジニアであれば1度は言われたことがあるんじゃないかという言葉はこれです。 「計測できないものは改善できない」という言葉があります。これはいろいろな引用元があるので（スライドの）後ろに画像を出していますが、計測した
「AWS CDK？学習コスト高そう。。」 AWS CDKは、プログラミング言語でインフラを定義できる便利なツールです。 反面、プログラミングに慣れていない人には学習コストが高そうに感じるかもしれません。 AWS CDKを使ったことがない方が学習を進めるのに役立つドキュメントや学習コンテンツをまとめてみました。 以下のような方の、参考になると嬉しいです。 AWS CDK何から始めればいいのかわからない 概要は知っているけど触ったことはない プログラミング言語を使うことにハードルを感じる 入門 とりあえず動かす とりあえず、動かしてみましょう。 CDK入門には「CDK Workshop」が有名ですが、以下の方がボリュームは少ないのでファーストステップにおすすめです。(所要時間 25分) AWS Cloud Development Kit (CDK) の開始方法 | はじめに こちらのガイドでは
書き始める とりあえずチュートリアルを一周しました。 https://github.com/k1LoW/ndiag/blob/main/docs/tutorial.ja.md チュートリアルの順に、nodesを書いてみてndiag doc --rm-dist、networksを書いてndiag ...、relationsを書いて以下略、とするのが良さそうです。 アイコンのキーはndiag list iconsで表示できるので、これを見ながらndiag.ymlに書き込んでいきます。 VSCode ExtensionsでMarkdown Preview Enhancedをインストール。 Previewを見ながらndiag.ymlを書いては生成、書いては生成します。 とりあえず --- name: Sample AWS web service docPath: docs/arch views:
プロジェクトドキュメント構築向け静的サイトジェネレータ『MkDocs』及び『Material for MkDocs』の個人的導入＆設定まとめ | DevelopersIO
プロジェクトドキュメント構築向け静的サイトジェネレータ『MkDocs』及び『Material for MkDocs』の個人的導入＆設定まとめ 直近携わっているプロダクトで「ユーザーガイド」的なドキュメントを作る機会があり、暫く前に幾つか見繕ってみた結果「MkDocs」というツールを選定して環境を作成＆整備して来ました。個人的にこのツールは使い勝手がとても良いと思っており、継続して使って来ていました。 当エントリでは今後の備忘録としてMkDocsの基本的な導入・設定方法と、そのMkDocsで適用させたスタイル「Material for MkDocs」をここまで使ってきた中での個人的Tipsなどをまとめておきたいと思います。 MkDocs Material for MkDocs - Material for MkDocs 目次 MkDocsとは MkDocsのインストール 基本操作 各種設定・
ドキュメントを書く仕事を探している
飲み会で「お前、次の転職どうするよ？」的な話をするときはいつも これまでは自分が一番下手くそなバンドメンバーになれる職場を意図的に探していたし、今の職場もその基準で選んだが、そろそろ俺の音楽をやりたい プログラミングそのものをドメインとした仕事をしたい ドキュメントやチュートリアルの整備をしたい。あわよくば今 blog.ojisan.io を書いていること自体が仕事になるようなことをしたい 的なことを言っている（はず、アルコールが入っているので記憶が定かでない）。 で、この最後の 「ドキュメントやチュートリアルの整備をしたい」というのはここ１年くらい言っている気がするのだが、そろそろ本当に動き出そうと思って最近ふわふわ考えていることを書いてみようと思う。そういう仕事をしている人の目に止まってくれると嬉しい。 どうしてドキュメントを書くような仕事をしたいのか いまこういったブログを運営してい
開発者向けのツールを展開する企業「JetBrains」がドキュメント作成のためのツール「Writerside」を早期アクセスで公開しました。早期アクセスの期間中はWritersideを無料で利用できるとのことなので、実際に使って試してみました。 Writerside - JetBrains が提供する新しい技術文書作成環境。 https://www.jetbrains.com/ja-jp/writerside/ Writersideの公式ページを開き、「ダウンロード」をクリックします。 今回はスタンドアロンツールとして利用するので、「ダウンロード」をクリックします。JetBrains IDEを利用している人はプラグイン形式で導入することも可能とのこと。 インストーラーがダウンロードされるのでダブルクリックして起動します。 「Next」をクリック。 インストールには空き容量が1.0GB必要で
ROUTE06では、GitLab Handbook*1を参考に、全社に関係する情報をハンドブックとして社内に公開しています。ハンドブックは2023年8月時点で383ページ*2あり、50人前後の組織規模の会社としては文章化に積極的なことが現れている数字だと思っています。 また、ハンドブックとは別に、プロジェクトごとのレポジトリでは技術選定や設計方針をADR*3で残していたり、参加したセミナーのレポートをGitHub Discussionsに書いていることからも、ROUTE06で働く人は文章を書くことが習慣になっていると感じます。 そんな中、ある日社内のSlackに一つの問いが投げかけられました。 ドキュメント文化というのは、たとえばマニュアルに書いてないから分からなかった・故になんらかの失敗が発生した場合、マニュアルに書いていなかったことが悪いみたいな考え方になるのでしょうか 社内のSlac
「全世界のサイトの4分の1はWordPressで作られている」といわれるほど普及が進んでいるコンテンツ管理システムのWordPressですが、使いこなすにはHTMLやCSS、PHPの知識が求められるなど、少しハードルが高い側面もあります。無料のブログ作成サービス「You Don't Need WordPress」を使うと、HTMLなどの知識や自前のサーバーがなくても、Googleドキュメントを操作するだけで画像や表が入った記事を作成することが可能です。 You Don't Need WordPress: Create A Blog With Google Docs https://www.youdontneedwp.com/ 上記URLにアクセスすると以下のように表示されるので、「Create Your Blog」をクリックします。 上から順にメールアドレス、ユーザー名、パスワード2回を入
[レベル: 中級] 動画 SEO に役立つ新しいリソースを Google は公開しました。 YouTube の動画と検索セントラルの技術ドキュメントでベストプラクティスを解説している。 動画 SEO 向け動画 Google 検索の動画を担当しているプロダクト マネージャの Danielle Marshak（ダニエル・マーシャク）氏が、動画 SEO の基本的なベストプラクティスをライトニングトークで解説しています。 次のトピックに触れています。 ウェブで動画を見つけられるようにする 動画構造化データでマークアップする 高品質なサムネイル画像を設定する 動画サイトマップを送信する 動画ファイルに Google がアクセスできるようにする 日本語字幕あり Marshak 氏は（当然）英語で話していますが、日本語字幕を利用できます。 歯車アイコン⚙️から [字幕] を選択し [日本語] を指定しま
Googleは、Google Docsの新機能としてドキュメントをMarkdown形式でエクスポートする機能やMarkdown形式のファイルをドキュメントとして読み込む機能などを発表しました。 具体的には以下の4つの機能が利用可能になります。 Markdown形式のテキストをGoogle Docsのドキュメントに変換してペースト Google DocsのドキュメントをMarkdown形式のテキストとしてコピー Google DocsのドキュメントをMarkdown形式のテキストとしてエクスポート Markdown形式のテキストをGoogle Docsのドキュメントとしてインポート 例えば、Google DocsのドキュメントをMarkdown形式のテキストとしてエクスポートする場合には、下記の「ダウンロード」メニューからMarkdowsn形式を選択することになります（下記の画像は現時点での
http://www.martinfowler.com/bliki/CodeAsDocumentation.html アジャイル手法はプログラミングをソフトウェア開発の中心的役割に押し上げた、とよく言われる——ソフトウェア エンジニアリング コミュニティがやってるようなことよりもずっと優秀だよなあ。 プログラミングが中心的役割となったのは、コードをソフトウェア システムにおける「（最）重要なドキュメント」と位置付けたことが理由なんだと思う。 おっと、よく誤解されるので先に反論しておこう。 先ほどの「コードは重要なドキュメントだ」という原則だけど、 「コードが”唯一の”ドキュメントだ」とは言ってない。 「XPではコードがドキュメントだ」とよく耳にするけど、 XPのリーダー達がそんなことを言ってるのは聞いたことがないなあ。 コードを補完するには、他にもドキュメントが必要なんだ。 なぜコードが重
What is Docusaurus ? Build optimized websites quickly, focus on your content - Docusaurus Keytar Docusaurus とは "最適化されたウェブサイトを迅速に構築し，本質に集中させる" というスローガンのもと Facebook 傘下のチームが開発している 静的サイトジェネレータです．特徴として，次の五つが挙げられています． Powered by Markdown => MDX Built Using React Content Search Ready for Translations Document Versioning ※ただし，まだまだアルファなので４，５については工事が進行中 追記：2021 年 5 月 12 日に β 版がリリースされ，2022/02/23 現在では beta.15
emDA on Twitter: "ETV特集「ドキュメント 精神科病院×新型コロナ」/ キツい内容だけど、ある意味ハイライトは日本精神科病院協会会長の山崎學のこれ。日本の精神科医療のヤバさをわかりやすく体現してたし、これを出せたのはNHKの「手柄」ではある。この「… https://t.co/nims5dceBw"
ETV特集「ドキュメント 精神科病院×新型コロナ」/ キツい内容だけど、ある意味ハイライトは日本精神科病院協会会長の山崎學のこれ。日本の精神科医療のヤバさをわかりやすく体現してたし、これを出せたのはNHKの「手柄」ではある。この「… https://t.co/nims5dceBw
完全無料！誰でも美しいオンラインドキュメントやWebサイトを作成できる「Slick」を使ってみた！ - paiza times
どうも、まさとらん（@0310lan）です！ 今回は、誰でも簡単に美しいオンラインドキュメントを無料で作成できるWebサービスをご紹介します！ 多彩なテンプレートやすぐに使えるコンテンツなどが搭載されているので、ちょっとしたドキュメントを作ってシェアするのに重宝します。また、カスタマイズ次第では個人サイトなどのWebページを公開する用途にも活用できるので、ご興味ある方はぜひ参考にしてください！ 【 Slick 】 ■「Slick」の使い方 それでは、「Slick」をどのように使えばいいのか詳しく見ていきましょう！ まずはサイトのトップページから【Sign up】ボタンをクリックして、無料のユーザー登録を済ませておきます。 ユーザー名、メールアドレス、パスワードを設定するだけなので簡単です。 （※GoogleやFacebookアカウントでもログイン可能） 以下のようなダッシュボード画面が表示
コードのコメントやドキュメントなどのテクニカルライティングを生成AIが提案、補完、校正など支援するツール「Grazie」、JetBrainsが提供開始。日本語は未対応
コードのコメントやドキュメントなどのテクニカルライティングを生成AIが提案、補完、校正など支援するツール「Grazie」、JetBrainsが提供開始。日本語は未対応 Kotlin言語や統合開発ツールIntelliJ IDEAなどの開発を行っているJetBrainsは、IT系のテクニカルライティングのためのAI作文支援ツール「Grazie」（紹介動画によると発音は「グラッツィ」のようです）を発表しました。 JetBrainsの説明によると、Grazieで利用している言語モデルはハイテク業界のテキストを学習させているため、テクニカルライティングを的確に支援できるとのことです。 Introducing Grazie, a new AI writing companion! Streamline non-coding tasks right inside your JetBrains IDEs,
このブラウザーはサポートされなくなりました。 Microsoft Edge にアップグレードすると、最新の機能、セキュリティ更新プログラム、およびテクニカル サポートを利用できます。
最新のmacOSに対応した仮想オーディオ入出力ユーティリティ「BlackHole」を利用して、Googleドキュメントに議事録などの自動文字起こしをしてもらう方法。
最新のmacOSに対応した仮想オーディオ入出力ユーティリティ「BlackHole」を利用してGoogleドキュメントに議事録などの自動文字起こしをしてもらう方法です。詳細は以下から。 以前、既に開発が終了したCycling ’74チームのSoundFlowerのように、特定のアプリからの音声を他のアプリに送るれる仮想オーディオデバイスをMac内に作成できる仮想オーディオ入出力ユーティリティ「BlackHole」を紹介したさい、WWDCのセッションや議事録をGoogleドキュメントの音声入力に接続することで簡単に文字起こしができるという事を教えていただいたので試してみてください。(コメントでのご指摘ありがとうございます) 設定 まず、文字起こしを行う音源が入ったMacにBlackHoleをインストールし、macOSのAudio MIDI設定アプリからBlackHoleの仮想オーディオデバイス
エンジニアのためのドキュメントライティング読みました。 最近の仕事の悩みに対して、方向性を示してくれた良い本でした。 www.amazon.co.jp 自分のチーム内にドキュメントの文化が無い人にお勧めします。 全体のざっくりした感想だと、この手の本にありがちな小言っぽいことは書いてなく、作って意味のあるドキュメントはどうあるべきかを書いてあります。仕事のドキュメントで悩んでいる人には、具体的な取り組みのアイデアがいっぱい見つかるでしょう。 背景 うちの会社は転職者が多く、開発への考え方がバラバラ。当然、ドキュメントに対する考え方もバラバラで必要なドキュメントがなかなか揃わない。今の仕事は各部署からの寄せ集めチームでもあり、ドキュメントのテンプレートみたいなものもない。 世代間の格差も結構ある。ベテラン勢はドキュメントは印刷され保管される前提であり、表示にバージョン、日付、部署、作成者など
最初に、infer について説明されている良サイト（公式ドキュメントを含む）はこちらです。 TypeScript 2.8 Conditional Types | TypeScript Documentation TypeScript 2.8 の Conditional Types について | Qiita TypeScript2.8 Conditional Types 活用事例 | Qiita TypeScriptのinferとは何か これらを読んでもなお理解不能だった私...。 手元でコードを書いてようやく理解できたので備忘録として記事を残します。 サンプルコードは TypeScript 3.5.1 で試しています。 前提となる知識 Generics と Conditional Types を理解していないと infer に苦戦します。ちょっと長いですがお付き合いください。 Generi
AWSのアクセスを管理するPolicyドキュメントは柔軟に可否を設定できてとてもすごい！ でも、柔軟がゆえに難しい！評価条件もよくわからない！ 具体例があると理解の助けになると考えているので、自分の考えを整理するために具体例を作りました。 具体例を見ながらPolicyドキュメントについて学んでいきましょう。 Policyドキュメントとは？ AWSでアクセスを管理するために、基本的にはIAMポリシーとIAMロールを作成し、それをIAMユーザーやAWSリソースにアタッチする必要があります。 ポリシーとアクセス許可 - AWS Identity and Access Management そのときに、IAMポリシーでアクセスする許可と拒否の条件をJSON形式で記述したものがPolicyドキュメントです。 Policyドキュメントの例 { "Version": "2012-10-17", "Sta
メルペイでプロダクトマネージャをしてます、さとじゅんです。 メルペイでto B向けプロダクトの開発をしてます。なので、主にto B向けプロダクトについての話になります。 たまに思うこと突然ですがPMは新しい機能を作る時は仕様書を書くことが多いですよね。 PRD（プロダクト要求仕様書）とかですね。 「Why」とか「What」とか「How」とか書きますよね。 それでリリースして運用していくと思うのですが、運用中にいろんな課題をこなしていくうちにひとつの事に気づきます。 「もう少しビジネスとシステムとオペレーションがひとつのつながりで理解できる資料が欲しいな」と。 to C向けのプロダクトに比べ、to B向けのプロダクトにはセールスやオペレーションのチームなど1つのプロダクトに関わる人が多くなる特徴があると思います。 PLGという考え方もあると思いますが、だいたいのto B向けプロダクトがto
宮永忠将＠歴史＆軍事もの書き on Twitter: "櫻井翔の問題、インタビューの内容どうこうより先に、軍隊での命令と実行、責任の所在っていう組織構造や法的裏付けをじっくり解説する方が重要なのでは。命令実行が最優先する末端の元兵士に対して人道的観点からの質問自体がナンセンスっていう合意がないスタッフが戦争ドキュメント作ってもねぇ。"
櫻井翔の問題、インタビューの内容どうこうより先に、軍隊での命令と実行、責任の所在っていう組織構造や法的裏付けをじっくり解説する方が重要なのでは。命令実行が最優先する末端の元兵士に対して人道的観点からの質問自体がナンセンスっていう合意がないスタッフが戦争ドキュメント作ってもねぇ。
講義情報¶ 講義室の備え付けのPCも利用できますが、自前のコンピュータを持参して講義を受けることをおすすめします。プログラミング環境は第1回目の講義で説明しますが、 Google Colab を用いてプログラミングを行います。各自、千葉大学から発行してもらったGoogleアカウントを確認しておいてください。千葉大が発行するG Suiteアカウントでのみ受講できます。個人で保有しているgoogle アカウントでは受講できないので注意してください。千葉大が発行するG Suiteアカウントをもっていない人は、Moodleにログインする等して確かめてください。 この講義を履修するためには、Google classroomに参加する必要があります。クラスコード「iulhbq6」です。 https://classroom.google.com/c/NjAyOTQ2MDk1MzE1?cjc=iulhbq
Platform Engineering Kaigi 2024 で「開発者向けドキュメントの改善」をテーマに登壇してきました - CADDi Tech Blog
こんにちは、Platform チームの @akitok_ です。 CADDi Platform チームでは、チームトポロジーの定義に基づいてストリームアラインドチームが自律的に仕事を届けられるようにするため、様々なアセットとそれに付随するドキュメントなどを提供しています。 Platform チームのミッションやその活動などについては、以下の記事などを読んでいただけますと幸いです。 なんでもやるがなんでもはやらない？CADDi の Platform チームは、何をするチームなのか？ - CADDi Tech Blog あれから 1 年、Platform チームのその後 - CADDi Tech Blog 今回、Platform Engineering Kaigi 2024 というイベントで、この Platform チームを取り巻く開発者向けドキュメント改善について登壇してきました。 この記事
pythonで学ぶ計算物理¶ このページは岡山大学理学部物理学科で開講されている講義「コンピュータ物理学2」の補助資料として公開しているものです。 pythonを使って物理学科の学生に身近な方程式を解くことで、計算物理の実践的な力を身に付けることを目指します。
設計書などドキュメント類は一切作りません！でもその代わりシステムの出来上がりは超速で価格も激安です。っていうベンダーの存在を知った
てとらα SI @TETRA_IT 設計書などドキュメント類は一切作りません！テスト結果もありません！でもその代わりシステムの出来上がりは超速で価格も激安です。っていう恐ろしい地方ベンダーの存在を知った。とにかく安く早くを求める地方企業や支社などの要望とマッチして管理不能なシステムが量産されてる 2024-05-28 09:25:50
Railsのプロジェクトがそこそこ大きくなり、ServiceやSerializerなどのカスタムレイヤーを追加してコードを細分化しているものの、レイヤーの役割やインターフェイスのルールが明確に決まっておらずふわふわとしていることを課題と感じていました。課題を解決するヒントを探すため、Railsの超巨大OSSプロジェクトであるGitLabの設計ドキュメントを読んでみました。 ガイドラインの必要性 まず初めにガイドラインの必要性が語られています。レイヤーの抽象化ができたとしても、それを正しく使えないと、あっという間にメンテナンスしにくいコードができてしまうということが説明されています。 例として、あるFinder（Finderはデータベースからデータを検索する抽象）の中で別のFinderを呼び出してはいけないということが挙げられています。もしそうしたなら、Finderにどんどんオプションが追加
【新バージョンを公開しました 2022.2.27】 Googleドキュメント用の簡易校正ツール（Webライターや編集者向け）をバージョンアップしました – Heartlogic-2 Googleドキュメントを使った編集・執筆支援のツールをGAS（Google Apps Script）で作りました。普段使いには問題ない仕上がりになったので、公開します。 ▼ツールの導入・カスタマイズ方法 Googleドキュメント簡易校正ツール：GASによる文章の一括置換／表記チェック どういうツールか？ どういう場面で使えるか？ 一括置換／表記チェック用テーブルはどういうものか？ 終わりに どういうツールか？ Googleドキュメント上で、文字列の一括置換と表記チェック（チェック用テーブルにある文字列を赤文字に変え、注意を促す）を行います。一括置換およびチェック用のテーブルはGoogleスプレッドシートで管理
Astroを選ぶ理由 🚀 Astroドキュメント
Astroは、ブログやマーケティング、eコマースなど、コンテンツ駆動のウェブサイトを作成するためのウェブフレームワークです。Astroは、新しいフロントエンドアーキテクチャを開拓し、他のフレームワークと比較してJavaScriptのオーバーヘッドと複雑さを低減することで知られています。高速でSEOに優れたウェブサイトが必要なら、Astroが最適です。 Astroはオールインワンのウェブフレームワークです。 Astroには、ウェブサイトを作成するために必要なすべてが組み込まれています。また、さまざまなインテグレーションやAPIフックがあり、プロジェクトを自分のユースケースやニーズに合わせてカスタマイズできます。 特筆すべき点は以下の通りです。 アイランド: コンテンツ駆動のウェブサイトに最適化されたコンポーネントベースのウェブアーキテクチャです。 自由なUI: React、Preact、Sv
読み手を理解してより良いドキュメントを書こう / Write better documents by understanding your audience
ドキュメントを書くときに、みなさんが気をつけていることは何でしょう？ 情報の正確さや文章表現など、さまざまなことに気をつけていると思います。これらに加え、ドキュメントを書く上では、「読み手の理解」が重要です。今回は、2023年3月に発行された『ユーザーの問題解決とプロダクトの成功を導く エンジニアのためのドキュメントライティング』の内容を元に、どのようにして読み手を理解するか、そしてその重要性を一緒に考えていきたいと思います。 古木 亮太朗 / LINE株式会社 Developer Contentチーム テクニカルライター この資料は以下イベントで発表した内容です。 https://line.connpass.com/event/279668/
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
【総裁選ドキュメント】石破氏「あつ森」活用へ バーチャル空間で交流
運用ドキュメント2019/20190824-odc-operation-document
面倒なドキュメント生成はCIにやらせよう - Gunosy Tech Blog
優れたドキュメントは目的にかなっている “読む目的”を達成させるために書き手が意識したい「2つの品質」
AWS CDKの学習方法 ドキュメントや学習コンテンツをまとめてみる | DevelopersIO
Google ドキュメントの「提案モード」って知ってますか？ 社内の書類レビュー時間を短縮！ ～Google ドライブのうまい使い方＜1＞【「G Suite」時短＆コラボ仕事術】
ndiagでAWSのアーキテクチャドキュメントを書く
コード開発と同じようにしてドキュメントが作成できるJetBrains製「Writerside」を使ってみた
ドキュメント文化を支える不文律 - ROUTE06 Tech Blog
無料でGoogleドキュメントからブログ記事を作成できる「You Don’t Need WordPress」レビュー
Google、動画SEOのベストプラクティスを公開。YouTube動画と技術ドキュメントで解説
Google Docs、Markdown形式でのドキュメントのエクスポート、インポートなど可能に
コードがドキュメントだ - Martin Fowler's Bliki (ja)
ドキュメント作成ツールの決定版！Markdown + React の体験を Docusaurus で
Microsoft 365 Copilot ドキュメント
エンジニアのためのドキュメントライティング - ぱたへね
公式ドキュメントを読んでもinferが理解できない人のためのinferの説明 - Qiita
S3バケットポリシーの具体例で学ぶAWSのPolicyドキュメント | DevelopersIO
セガが社内勉強会の資料を無償公開 ～数学は不要？ 断じて否、ゲーム開発ではバリバリ使うぜ！／PDFドキュメントで150ページ超の大分量。ラスボス概念「クォータニオン」に挑め！【やじうまの杜】
PMによる仕様書では補えない運用フェーズに強いドキュメント作り｜さとじゅん
講義情報 — コンピューター処理 ドキュメント
【Mac Info】 Macでかんたん文字起こし!「Google ドキュメント」で自動化しよう
「Google ドキュメント」にソースコードを美しく整形・色分け表示する機能が追加／スマートキャンバス機能でコードブロックを設定可能に
pythonで学ぶ計算物理 — pythonで学ぶ計算物理 ドキュメント
Railsの設計に迷ったのでGitLabの設計ドキュメントを読んでみた | DevelopersIO
Googleドキュメント用の簡易校正ツールを作ったよ（編集者・ライター向け） - Heartlogic-2