並び順

ブックマーク数

期間指定

  • から
  • まで

201 - 240 件 / 255件

新着順 人気順

documentationの検索結果201 - 240 件 / 255件

  • UXライターが解説する超実践的UXライティング入門|nao | UXライター / コピーライター | 著書『#秒で伝わる文章術』発売中

    はじめに 私は事業会社(楽天→スタートアップ)でUXライティングを専門としてプロダクトの開発に携わっています。しかし、事業会社で私のような専任のUXライターやコピーライターを雇用している企業は決して多くありません。 多くの場合、UXデザイナーやUIデザイナー、エンジニア、プロダクトマネージャー、マーケターなど、UXライティングに比較的近い立場の方が、自分自身でUIテキストを書かなければならない、というのが実情だと思います。 そうした状況で試行錯誤されている方に向けて、自分に何かできることがあるのではないかと思い、このnoteを書くことに決めましたら。私がUXライティングの知見をしっかりと整理して伝えれば、役に立つのかもしれないと。 このnoteでは、私なりの実践的なUXライティングの方法論を言語化します。あくまで私が実践しているものなので、考え方もやり方も違うし、こんなのUXライティングじ

      UXライターが解説する超実践的UXライティング入門|nao | UXライター / コピーライター | 著書『#秒で伝わる文章術』発売中
    • https://awslabs.github.io/smithy/

      • ミーティングログ/議事録の取り方についてのメモ

        この記事はミーティングログの取り方についてのメモです。 以前書いた勉強会でのメモの取り方と似た話です。 勉強会でのメモの取り方について | Web Scratch 自分は書きながら話を聞くのが習慣化しているので、こんな感じでミーティングログ(ミーティングノート)を書いていますという話です。 この記事はメモ書きなのであんまり読みやすくないです。 このログの取り方は正確さログや整形されたログを取る方法ではありません。 2種類のミーティングログ 自分の場合は主に2種類のミーティングログを取ることが多いです。 ミーティングの内容によってどちらで取るのかを使い分けています。 リアルタイムモード 対面、リモートでのミーティング 回想モード ブレスト系のミーティング(JavaScript Primerの出版に関するミーティングなど) この記事ではこの2つのミーティングログの取り方について書いていきます。

          ミーティングログ/議事録の取り方についてのメモ
        • AWS Docs GPT

          AI-powered Search and Chat for AWS Documentation

            AWS Docs GPT
          • Documentation as Codeで継続的なドキュメント運用を実現する / July Tech Festa 2021 winter

            July Tech Festa 2021 winter [D-5] https://techfesta.connpass.com/event/193966/

              Documentation as Codeで継続的なドキュメント運用を実現する / July Tech Festa 2021 winter
            • 社内のドキュメンテーションの取り組みと、Kitenのご紹介 - Pepabo Tech Portal

              はじめに 技術部の @june29 と申します。最近の趣味は「お散歩」で、よく晴れた休日には妻といっしょに2時間くらい歩き回ったりしています。この記事では、わたしが2020年から力を入れて取り組んでいる社内におけるドキュメンテーションの活動の一部を紹介したいと思います。 問題意識 もともと、ペパボで働く人々には「書く」という行為が定着しています。現在利用中のサービスを見渡してみると、GitHub、Slack、Google Docs、Scrapbox、Notionなどがあり、常に積極的な読み書きが行われています。 しかし、ドキュメンテーションという観点から見て、すべてが理想的にうまくいっているとは言えない状況であるとも思っていました。具体的には、下記のような課題があると感じていました。 書く場所が何種類もあり、どこになにが書かれているかがわかりにくい 場所ごとにアクセス制限が行われており、ど

                社内のドキュメンテーションの取り組みと、Kitenのご紹介 - Pepabo Tech Portal
              • Tailwind CSS v3.0 - Tailwind CSS

                Tailwind CSS v3.0 is here — bringing incredible performance gains, huge workflow improvements, and a seriously ridiculous number of new features. Tailwind CSS v3.0 is here — bringing incredible performance gains, huge workflow improvements, and a seriously ridiculous number of new features. For a tour of some of the coolest new features, check out the “What’s new in Tailwind CSS v3.0” video on our

                  Tailwind CSS v3.0 - Tailwind CSS
                • Isoflow | Network Diagrams

                  🎉 Isoflow v2 has landed 🎉  Customers with accounts created before 7th November 2023 (2 months ago), please read this.

                  • Design Docs への思い

                    Message Passing での話題を契機に、色々な人が自身の Design Docs 観を共有していて、とても興味深く読ませてもらいました。普段「仕事を進める上で当たり前に必要なもの」として書いている自分に気づき、これを機に自分の Design Docs 観も言語化してみようと思ったのが本記事です。実践の一例を付け加えることが狙いであり、「Design Docs はかくあるべき」と主張するものではないです。 はじめに 「人によって思い浮かべる Design Docs 観が全然違う!多様で面白い!!」というのが話の出発点ですが、さすがに想定しているものが違いすぎると話が発散してしまうので、本記事では Design Docs を「ソフトウェアエンジニア (私) が何らかのプロジェクトやタスクを進める上で書く文書」としておきます。 次に私の立場を明確にしておきます。私はオープンソースのウェ

                      Design Docs への思い
                    • JavaScriptに「型」を ~Microsoftが新構文を提案へ/TypeScriptの知見をもとにした「コメントとしての型」

                        JavaScriptに「型」を ~Microsoftが新構文を提案へ/TypeScriptの知見をもとにした「コメントとしての型」
                      • 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
                        • 小さなチームのオウンドメディア戦略

                          リソースが少ない小さいチームがどうやって成果が出るオウンドメディアを運営するかを、自社の経験をもとに基本的なノウハウをまとめています。(2019年10月に登壇したCMCJで使ったスライドを加筆修正したものです)

                            小さなチームのオウンドメディア戦略
                          • Terraform構成をビジュアライズできるツール Pluralithを使ってAWS構成図を自動作成してみる | DevelopersIO

                            CIに組み込むことで真価を発揮するツールかと思うので、Localは検証・実運用はCIといった使い分けをするのが良さそうです。 やってみた 今回はLocalで試してみます。 Pluralith CLIのインストール 利用にはユーザー登録が必要です。 以下のページからユーザー登録します。 Pluralith サインインができたら以下のページに遷移します。 Localで試したいため、Local Setupを選択します。 Download CLIでバイナリをダウンロードして、macの場合は以下のコマンドでcliを利用できるようにします。 mv pluralith_cli_darwin_amd64_v0.2.2 pluralith mv pluralith /usr/local/bin/ chmod +x /usr/local/bin/pluralith ブラウザで表示されているAPI Keyを使っ

                              Terraform構成をビジュアライズできるツール Pluralithを使ってAWS構成図を自動作成してみる | DevelopersIO
                            • 伝えたい人に届ける技術記事の書き方 - Qiita

                              こんにちは、リファクタリングが大好きなミノ駆動です。 この記事は READYFORアドベントカレンダー2021 、初日の記事です。 なにこれ? 苦労して執筆した技術記事は、伝えたい人にしっかり伝えたいですよね。 また、最後まで読んでもらいたいですよね。 一方で、構成などに課題があって、伝えたい人になかなか伝わらないことがあります。 この記事は、伝わる記事の書き方について、私の個人的なノウハウを書き記したものです。 これからアドベントカレンダーの記事を執筆される皆さんにとって、少しでもお役に立てられれば幸いです。 この記事のゴール 以下の理解を得ることをゴールとします。 以下2つの要件を踏まえた記事構成を心がけること。 構成要件①:技術を紹介する上で最低限説明の必要な内容を網羅すること。 特に課題をしっかり伝えること。 構成要件②:読み手が段階的に理解しやすい順番になっていること。 告知の仕

                                伝えたい人に届ける技術記事の書き方 - Qiita
                              • GitHub - mingrammer/diagrams: Diagram as Code for prototyping cloud system architectures

                                A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

                                  GitHub - mingrammer/diagrams: Diagram as Code for prototyping cloud system architectures
                                • エンジニアリングの時間を生み出すドキュメンテーション術 - エムスリーテックブログ

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

                                    エンジニアリングの時間を生み出すドキュメンテーション術 - エムスリーテックブログ
                                  • Introducing Hermes, An Open Source Document Management System

                                    TerraformInfrastructure as code provisioning​​​​‌‍​‍​‍‌‍‌​‍‌‍‍‌‌‍‌‌‍‍‌‌‍‍​‍​‍​‍‍​‍​‍‌‍‌​‌‍​‌‌‌​‌‍‌‍​‌‍‌‌​​‍‍‌‍​‌‍‌‍‌​‍​‍​‍​​‍​‍‌‍‍​‌​‍‌‍‌‌‌‍‌‍​‍​‍​‍‍​‍​‍‌‍‍​‌‌​‌‌​‌​​‌​​‍‍​‍​‍‌‍‍​‌‍​‌‌​‌‍‍​‌‍‍‌‌‍​‌‍‌​‍‌​​​‍‍‌‍​‌‌‍‌​‌‍‌‌‍‍‌‌‍‍​‍‍‌‍‌​‌‍​‌‌‌​‌‍‌‍​‌‍‌‌​​‍‍‌‍​‌‍‌‍‌​‍‌‍‌‌‌‍‌​‌‍‍‌‌‌​‌‍‌​‍​‍‌‍‍‌‌‌​‌‍‌‌‌‍‌‌‌‌‌​‌‍‌‌​​‌‍‌‌‌​​‍‌‌‍‌​‌‍

                                      Introducing Hermes, An Open Source Document Management System
                                    • プロダクトマネージャーの必須スキル: デザインドックの書き方 - Design Doc|kosuke mori

                                      私 (@kossmori) が働くアメリカのスタートアップでは、どんな会話においても ”Is there a design doc?” (デザインドックはないの?) という質問が連発します。 会話のコンテクストを合わせるため、取り組みの背景を理解するための必須資料として位置づけられています。 デザインドックは技術詳細を書いた仕様書ではありません。 取組みに関わる Why, What, How と、ハイレベルな実装戦略、主要な設計上の決定、決定の際に考慮されたトレードオフに重点を置いて文書化したもので、それをもとにエンジニアは必要に応じてTech docを書き、デザイナーはデザインを始めます。 追記: その2も書きました。最後の方に記事へのリンクを貼っています。 追追記:  思った以上に反響あり、この記事のおかげでこれまで非常に多くの スタートアップの方々とお話しさせていただく機会をいただき

                                        プロダクトマネージャーの必須スキル: デザインドックの書き方 - Design Doc|kosuke mori
                                      • “AWS公式サイト風”にカップ麺を紹介する画像が話題 分かりにくい説明文をそれっぽく再現 「もはやAWS文学」

                                        「AWSの各サービス、冒頭の説明文見てもどういうものなのか全然分からなくない? もしAWSがカップラーメン発売したらこんな感じの紹介してると思う」──こんな考えから生まれた、“AWS公式サイト風”にカップ麺を紹介する画像が話題だ。Twitterでは「もはやAWS文学」などの反応があり、5月10日時点で1万3000いいねを集めている。 作成したのは、書籍「OpenCVではじめよう ディープラーニングによる画像認識」などを執筆するKazuya Gokitaさん(@kazoo04)。画像では、カップ麺を「Amazon CR」というサービスだと仮定し、特徴を以下のように説明している。 Amazon CRは、わずかなアクションで素早く安全に喫食可能なフルマネージド統合サービスです。CRを使用すればホットスタンバイ状態のH2OあるいはRawとして麺、醤油または味噌、また葱、肉などを単一のフローとして提

                                          “AWS公式サイト風”にカップ麺を紹介する画像が話題 分かりにくい説明文をそれっぽく再現 「もはやAWS文学」
                                        • インフォーマルな文章を書く楽しさ / secondlife - Message Passing

                                          皆さんはじめまして。ゲストとして呼ばれた、secondlife です。Tateno Culture といった形で以前森田さんが書いていたが、あれは Tateno Culture というよりは Hatena Culture の話だと思っています。なので、今回はインフォーマルな文章という主題とはずれるかもしれませんが、自分はなぜそんな感じの文章を書いていたのか、というのを当時のはてな時代を振り返り書いてみようと思います。 はてな社に居た当時、これが皆さんの想定するインフォーマルな文章かはさておき、さまざまな社内向け文章を社内の全員、とは言わないまでも、7-8割の人がけっこう書いていた。 自分もしょっちゅう書いていたのだけど、なぜ書いていたのかを今更考えると、それはひとえに『楽しかったから』だった。 なぜ楽しかったのか 当時は2006年頭、自分は15人目の社員として会社にジョインした。入社すると

                                            インフォーマルな文章を書く楽しさ / secondlife - Message Passing
                                          • マネジメント業を通じて考えた、プロジェクト全体像の認識齟齬を防ぐ誤解されないドキュメント作成術 - ANDPAD Tech Blog

                                            アンドパッドの土方です。 本ブログではEMインタビューで取り上げておりますが、記事投稿は初めてです。 エンジニアマネージャーとしてのイベント登壇や、プロジェクト推進における案件の取りまとめ業務が増えてきており、それに伴ってドキュメントを作成する機会も増えてきました。 自分の考えを整理するとともに、アンドパッドのエンジニアにはこんなこと考えている人もいるよ、的な意味で紹介したいと思います。 何かの参考になれば幸いです。 結論! 次項からは文字ばっかりで語っているだけになりますので先に結論を書きます。 断面を作るための切り方を意識する 網羅性、単一性を守る 二軸で表現する この三項を守ることで、理解されやすく誤解を招かないドキュメントの完成に近づけると考えています。 ではここからだらだら語ります。 ドキュメントの目的は? そもそもドキュメントはなんのために作るものでしょうか。 私は、「認識を合

                                              マネジメント業を通じて考えた、プロジェクト全体像の認識齟齬を防ぐ誤解されないドキュメント作成術 - ANDPAD Tech Blog
                                            • 方法不確実性を下げるための松竹梅メソッド - 貳佰伍拾陸夜日記

                                              若手メンバーのスキルアップのための相談に乗っていると, うまい設計ができるようになる, 仕様の整理やメリット・デメリットの判断がうまくなる, あるいは技術の引き出しを増やすにはどうしたらよいか, という話がよく挙がる. この手の話題にいつも同じようなアドバイスをしていると気づいたので, 説明を楽にするために書き下しておく. ソフトウェア開発の話だけど, もしかしたら一般的な仕事のやり方の話だと思っても成立するかもしれない. 文脈 ソフトウェア開発のプロジェクトを進めるとき, 少人数の精鋭だけで開発するなら極論するとカウボーイコーディングでも成立するかもしれない. そうでなければ, たとえばスクラムのように, なんらか段取りをチームでマネジメントし, 不確実性を下げるためにどういう方法でアプローチするか検討し, 仕様を固めて細かいタスクに分解するプロセス(以降ざっくり「ソリューションを定める

                                                方法不確実性を下げるための松竹梅メソッド - 貳佰伍拾陸夜日記
                                              • ユーザーはドキュメントを「読みにくるけれど読んでいない」 “流し読み”しやすいドキュメント作成のポイント

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

                                                  ユーザーはドキュメントを「読みにくるけれど読んでいない」 “流し読み”しやすいドキュメント作成のポイント
                                                • Design Docs のいけすかなさ / morrita - Message Passing

                                                  Design docs というのが昔からあまり好きでない。読むのも書くのも好きでない。 仕事で文書を書くのはやぶさかではないけど Design docs はなんとなくいや。 せっかくなのでこのイヤさを言語化してみたい。 Design Docs とはなにか 自分が想定している Design docs は この文章が説明しているようなものだ。 なにかそれなりの規模があるものを作る時に設計やそのトレードオフをざっと文書化する文書。 もっというと一般名詞の design docs ではなく、リンク先に書いてあるような自分の勤務先固有の The Design Docs 文化が好きでない。 「設計やそのトレードオフをざっと文書化する。」 それだけ聞くと割と良いもののような気がして、自分もある時期までは良いものだと思っていた。 「ドキュメンテーション」というのは、プログラミングのポップカルチャーにおいて

                                                    Design Docs のいけすかなさ / morrita - Message Passing
                                                  • システムの変化に追従可能でかつ理解し易いドキュメントシステムのモデル化 / Web System Architecture #8

                                                    https://github.com/k1LoW/wsa-sg-8th-draft

                                                      システムの変化に追従可能でかつ理解し易いドキュメントシステムのモデル化 / Web System Architecture #8
                                                    • 運用ドキュメント2019/20190824-odc-operation-document

                                                      Open Developer Conferenceでの登壇資料です。 https://www.ospn.jp/odc2019/modules/eguide/event.php?eid=31 (運用設計ラボ合同会社 波田野裕一)

                                                        運用ドキュメント2019/20190824-odc-operation-document
                                                      • Announcing the New TypeScript Handbook - TypeScript

                                                        Hey folks, we’re happy to announce that a fresh re-write of the TypeScript Handbook is out of beta and is now our website’s primary resource for learning TypeScript! Read the handbook on Web / Epub / PDF In the last year, the TypeScript team has heavily focused on ramping up the scale, modernity and scope of our documentation. One of the most critical sections of our documentation is the handbook,

                                                          Announcing the New TypeScript Handbook - TypeScript
                                                        • 目的に沿ったDocumentation as Codeをいかにして実現していくか / PHPerKaigi 2021

                                                          https://fortee.jp/phperkaigi-2021/proposal/42ce8b07-6972-42bb-a2ac-96af7249cfa4 あるシステムを理解して開発を開始するとき、必要なのはInfrastructure as Codeを含むソースコードだけでは大抵の場合は不十分です。では挙動がわかるようなテストコードがあれば十分かというとそうでもありません。 いわゆる「オンボーディングの効果的な運用」「開発開始までのオーバヘッドの削減(PHPerKaigi2020で発表)」は継続的な生産性向上のためには考えなければならない要素です。 そして、上記を補完するためにしばしばドキュメントが書かれます。 私はドキュメント運用のアプローチとして「コードによる生成を含んだドキュメント運用」に興味を持っています。 私はこれを「Documentation as Code」と呼んでいま

                                                            目的に沿ったDocumentation as Codeをいかにして実現していくか / PHPerKaigi 2021
                                                          • 実践ADR - kawasima

                                                            Architecture Decision Records(ADRs)は、アーキテクチャ上の意思決定をドキュメントとして残す方法の1つです。Release It!の著者であるMichael Nygardのブログによって広まり、ThoughtWorks社のTechnology Raderでも「adopt」になっています。

                                                              実践ADR - kawasima
                                                            • GitHub - carbon-language/carbon-lang: Carbon Language's main repository: documents, design, implementation, and related tools. (NOTE: Carbon Language is experimental; see README)

                                                              Fast and works with C++ Performance matching C++ using LLVM, with low-level access to bits and addresses Interoperate with your existing C++ code, from inheritance to templates Fast and scalable builds that work with your existing C++ build systems Modern and evolving Solid language foundations that are easy to learn, especially if you have used C++ Easy, tool-based upgrades between Carbon version

                                                                GitHub - carbon-language/carbon-lang: Carbon Language's main repository: documents, design, implementation, and related tools. (NOTE: Carbon Language is experimental; see README)
                                                              • 優れたドキュメントは目的にかなっている “読む目的”を達成させるために書き手が意識したい「2つの品質」

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

                                                                  優れたドキュメントは目的にかなっている “読む目的”を達成させるために書き手が意識したい「2つの品質」
                                                                • ドキュメント文化を支える不文律 - ROUTE06 Tech Blog

                                                                  ROUTE06では、GitLab Handbook*1を参考に、全社に関係する情報をハンドブックとして社内に公開しています。ハンドブックは2023年8月時点で383ページ*2あり、50人前後の組織規模の会社としては文章化に積極的なことが現れている数字だと思っています。 また、ハンドブックとは別に、プロジェクトごとのレポジトリでは技術選定や設計方針をADR*3で残していたり、参加したセミナーのレポートをGitHub Discussionsに書いていることからも、ROUTE06で働く人は文章を書くことが習慣になっていると感じます。 そんな中、ある日社内のSlackに一つの問いが投げかけられました。 ドキュメント文化というのは、たとえばマニュアルに書いてないから分からなかった・故になんらかの失敗が発生した場合、マニュアルに書いていなかったことが悪いみたいな考え方になるのでしょうか 社内のSlac

                                                                    ドキュメント文化を支える不文律 - ROUTE06 Tech Blog
                                                                  • GoogleやMicrosoftなどIT大手連合が「Open Web Docs」を発表

                                                                    GoogleやMicrosoftらで構成される大手IT企業連合が2021年1月26日に、Web開発者向のオープンなドキュメンテーションを支援するプロジェクト「Open Web Docs」の設立を発表しました。Mozillaも参加するこのプロジェクトは、Mozillaの不振により下火となっていたMDN Web Docsの空白を埋めるものになると期待されています。 Open Web Docs - Open Collective https://opencollective.com/open-web-docs/updates/introducing-open-web-docs Browser makers launch new project for writing documentation for Web APIs | ZDNet https://www.zdnet.com/article/

                                                                      GoogleやMicrosoftなどIT大手連合が「Open Web Docs」を発表
                                                                    • HTML, CSS, JavaScriptの標準の仕様書はどこにあるのか

                                                                      HTML HTMLの仕様策定には複雑な歴史があります。詳細は他の解説記事に譲りますが、簡単に述べるとW3CとWHATWGのダブルスタンダード状態が長い間続いていました。2022年現在はWHATWGによってLiving Standardとしてまとめられた仕様が実質的な標準となっています。Living Standardという名前が示す通り、バージョンはなくエディターによって随時更新されています。 CSS CSSの仕様はW3Cが策定しています。現在は、CSSとして1つの標準仕様があるわけではなく、数多くのモジュールに分かれて標準仕様の策定が進められています。草案、勧告候補などを経て勧告に至るプロセスと、Levelという概念で整理されたバージョン管理が特徴です。年に1度、SnapShotとしてその時点での標準化の概況が公開されています。 JavaScript JavaScriptは主にWebブラウ

                                                                        HTML, CSS, JavaScriptの標準の仕様書はどこにあるのか
                                                                      • ドキュメント作成ツールの決定版!Markdown + React の体験を Docusaurus で

                                                                        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 ※ただし,まだまだアルファなので4,5については工事が進行中 追記:2021 年 5 月 12 日に β 版がリリースされ,2022/02/23 現在では beta.15

                                                                          ドキュメント作成ツールの決定版!Markdown + React の体験を Docusaurus で
                                                                        • Tests as Documentation - たにしきんぐダム

                                                                          production code の設計についてはよく議論される一方、ユニットテストをどう書くべきかについてはあまり議論されることが少なく。とにかくカバレッジが高ければヨシみたいな感じで軽く扱われていることが多い気がする。 その結果、テストを書くときやとりわけテストを追加するときに "良くない" 方法でテストを追加/拡張してしまい、メンテナンスしにくく壊れやすい・(未来の自分でも)読んでも何を検証しているのか分からない、テストが落ちても不安だけを煽り何が問題なのか分からない、技術的負債が誕生してしまう。 詳しいことは本 ( XUnit Test Patterns など? 詳しい人は僕に紹介してください)を読んだりチームメンバーと議論するのが良いと思うが、この記事を読んでテストの書き方に対する意識を啓発できたらなと思っている。 理想を述べるのは簡単だけど現実は大変、頑張ろう introduct

                                                                            Tests as Documentation - たにしきんぐダム
                                                                          • 査読者の指示通りに変更しないことを伝えるための方法と言い回し|ThinkSCIENCE株式会社|英文校正・学術論文翻訳

                                                                            査読者は学術出版のプロセスになくてはならない存在です。皆さんの論文を科学的により強固なものにし、読者に明確に理解され得るものとなるように、査読者は様々なコメントや指示・提案をします。それに応えることは、査読プロセスにおいて非常に重要なステップです。しかしながら、査読者からの提言に必ずしも同意できないこともあるでしょう。 まず初めに申し上げておきたいことは、必ずしも査読者の指示通りにすべてを変更する必要はないということです。査読者によって示唆する変更の重要度が異なるだけではなく、査読者のコメントを考慮しつつも、論文を採用するかしないかを最終的に決定するのはジャーナルエディターであって、査読者自身ではないからです。とは言っても、論文を指示通りに変更しないと決める前に、まず次の問いかけに答えてみることをお勧めします。 1. 査読者は、研究内容が明確に説明されていないということを指摘していますか?

                                                                            • GitHub+CircleCIによる業務要件の記述精度向上の取り組み - ZOZO TECH BLOG

                                                                              こんにちは。MSP技術推進部の手塚(@tzone99)です。 この記事では、エンジニア向けのツールを周囲のエンジニア以外のチームにも導入し、チームを跨いだコミュニケーション上の課題を解決した事例をご紹介します。 普段エンジニアとしてプロダクトを開発する中でも、エンジニア同士のやり取りだけで業務が完結しないケースも多いかと思います。周囲のチームとやり取りする中でコミュニケーションのずれが発生した場合の対応として、今回の事例が参考になれば幸いです。 MSP技術推進部の活動について興味のある方はこちらの記事もぜひご覧ください。 techblog.zozo.com techblog.zozo.com techblog.zozo.com techblog.zozo.com 目次 目次 背景 コミュニケーション上の課題 業務要件のMarkdown/PlantUML化 運用の初期対応 自作のLinter

                                                                                GitHub+CircleCIによる業務要件の記述精度向上の取り組み - ZOZO TECH BLOG
                                                                              • PMによる仕様書では補えない運用フェーズに強いドキュメント作り|さとじゅん

                                                                                メルペイでプロダクトマネージャをしてます、さとじゅんです。 メルペイでto B向けプロダクトの開発をしてます。なので、主にto B向けプロダクトについての話になります。 たまに思うこと突然ですがPMは新しい機能を作る時は仕様書を書くことが多いですよね。 PRD(プロダクト要求仕様書)とかですね。 「Why」とか「What」とか「How」とか書きますよね。 それでリリースして運用していくと思うのですが、運用中にいろんな課題をこなしていくうちにひとつの事に気づきます。 「もう少しビジネスとシステムとオペレーションがひとつのつながりで理解できる資料が欲しいな」と。 to C向けのプロダクトに比べ、to B向けのプロダクトにはセールスやオペレーションのチームなど1つのプロダクトに関わる人が多くなる特徴があると思います。 PLGという考え方もあると思いますが、だいたいのto B向けプロダクトがto 

                                                                                  PMによる仕様書では補えない運用フェーズに強いドキュメント作り|さとじゅん
                                                                                • GitHub - mintlify/writer: ✍️ AI powered documentation writer

                                                                                  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 - mintlify/writer: ✍️ AI powered documentation writer