ドキュメントをいい具合に残そうの会 - Qiita
最近、『エンジニアのためのドキュメントライティング』という本を読みました。 非常にためになる内容だったので、本書であがったいくつかのポイントを私なりにまとめてみました。 また、エンジニアにとってのドキュメントは種類が多く、それぞれのニーズとそれに合わせたフォーマットも違うため、 良いドキュメントとは何か？ を一概に述べることは難しいです。 個人的には、「ほぼ知識のない人が読んでも再現できる・解決できる」ということが大事なのではないかと思っています。 そこで、本記事ではドキュメントの範囲を少し絞って、想定される読者をエンジニア寄りに考えて書いています。ご了承ください。 目次 本記事では ドキュメントを作成する前 ドキュメントを作成する時 ドキュメントを作成した後 それぞれのタイミングにおけるポイントを挙げていきます。 📑 ドキュメント作成前のポイント フリクションログとは、あるユーザー1の
jQueryへの別れ：現代的な開発のための必須JavaScriptメソッド - Qiita
はじめに 私は長い間レガシーコードと共に仕事をしてきましたが、jQueryの重要性は依然として頻繁に話題に上がるトピックの一つです。ライブラリ自体は便利なままですが、それは別の時代のニーズを完璧に満たしていました。 現在、私たちは既にES2023について話していますが、過去にjQueryがカバーしていたほとんどの機能は、すでに2015年にリリースされたES6に取り込まれています。 ES6の標準は既に広範にサポートされており、96％のレベルに達しています（出典：caniuse.com）。そのため、特に要素の選択、スタイリング、アニメーション、データの取得などの基本的なタスクについては、ライブラリの使用を見直す良いタイミングかもしれません。 以下のトピックは、いくつかの標準的なjQueryのパターンと、それに相当するバニラJavaScriptでの手法を示す参考資料として役立つと思います。 要素
AT Protocol (BlueSky Social)仕様解説 ～ W3C DID仕様を添えて ～ - Qiita
結論 まだMastodon以下の機能実現状況なので、SNS目的で参加するのはNostr以上に勧めしません。 API叩いて遊べる人や、自分で問題解決できる人向け ※現在、基本機能も完成していないためクローズドβ中です。 公式サーバーの作成には、既存ユーザーに発行される招待コードが必要です(2週間に付き1個) 有志の非公式サーバーもそちら用の招待コードが必要になりました。 まだまだ仕様も未完成！！！破壊的変更も色々起きるぞ！ ※コードを買ってまで参加するものではないと思います。開発やフィードバックに協力できる人のみ参加すべき。 はじめに Twitterの動乱に巻き込まれ、移住先にMisskeyやMastodonなど選ばれつつある今日このごろ、皆様いかがお過ごしでしょうか。 つい先日、BlueSkyのクローズドベータが開始されました。 BlueSkyは、Nostr同様Twitter創設者のジャッ
ディレクトリ構成図を書くときに便利な記号 - Qiita
テキストベースでちょっとしたディレクトリ構成図を書きたい時、いつもあの記号どうやって出すっけ？？となる。なので、いい加減メモすることにした。 以下のようなのを書きたい root/ ├ bin/ ├ etc/ ├ usr/ │ └ local/ │ └ bin/ └ lib/ コピペ用記号集
伝わる文章作成の基本を学ぶための記事・学習コンテンツのまとめ - Qiita
短いメッセージを書くことはできても、まとまった文章を書くのに苦労している人は多いのではないでしょうか。 この記事では、まとまった文章を作るときの技術を学ぶことができる記事や学習コンテンツを紹介します。新人エンジニア向けです。 文章の「型」を学ぶ まとまった文章を書くには、「型」が必要です。頻繁に使うものは、「型」を覚えてしまいしましょう。 バグレポートの書き方を学ぶ エンジニアとして書く文章の代表例が、バグレポートです。 バグレポートでありがちな失敗として「何が問題だと思っているのか」が伝わらないというものがあります。 これを防ぐために、「期待する結果」「実際の結果」「再現手順」の3つを必ず書くようにしましょう。 質問の書き方を学ぶ エンジニアが扱う技術は、最初はわからないことだらけです。 それを解決するために、質問の文章を作成する技術が必要となります。 概ね下記の4つの情報があれば、良い
実践テクニカルライティング - 開発者が「外国語」を使うときの言語技術達3つ - Qiita
言語技術 というものをご存知でしょうか。 言語技術とは、思考を論理的に組み立て、相手が理解できる様に分かりやすく表現すること。 人前で話す能力や議論の能力、文章を書く能力や論文を書く能力はトレーニングによって身につけられる。我々開発者にとっても、普段の語彙に距離のある相手、たとえば非技術者との会話の際にこの言語技術を意識することがキーになる。記事のタイトルは「外国語」と書いたが、英語は勿論、開発者にとって顧客や非技術者は時として「外国人」。開発者にとって、例えば 英語学習 テクニカルサポートのやり取り の時等に使える、情報を整理する言語技術とツールについて、3つのトピックからまとめた。 『外国語を身につけるための日本語レッスン』に学ぶ、言語技術 『情報を整理するたった5つの方法 LATCH』 Google Sheets 等で、「外国語」を使う相手と状況共有をうまくする仕掛け 1. 『外国語
僕「SaaS色々あって迷うな〜」お母さん「Notionにしときなさい。大きくなっても使えるから」 - Qiita
はじめに ※この記事はConfluenceに関連したネガティブな内容を含みます。弊社はNotionが合っていたというだけで他のサービスを貶める気持ちは全くない旨ご理解ください (2021/2/24) こちらの記事の続きを書きました。 https://qiita.com/shushutochako/items/626007cc3d67cfdc782f ある日のMTG終わりの雑談中 社長 「最近Notionというの使っててめっちゃいいんですよ！！！」 僕 「はあ〜 そうなんですか〜」 社長 「ぴゅいっとカンバンとかタイムラインとかTODOリスト作れるんですよ！！！」 僕 「はー それはすごいですね〜」 （ゆーて他のWikiツールと大差ないやろ〜） 社長 「今社内で使ってる色々なツールからNotionに集約したいですねー！」 僕 「そうですねー 検討してみます〜」 （鼻ほじー ※弊社はリモートワ
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
