# はじめに GitHub Changelog を元に、GitHub Actions がどのように更新されていったかを簡単にまとめました。 あまり深いところまでは書いてないので、気になった変更があったら各自調べてください（もっと色々書きたかったけど時間なかった）。 わりと雑に作ったので漏れや間違いがあったらコメントとか下さい。 2021/12/01 までの情報をもとにこの記事は書かれています。 この記事は GitHub Actions Advent Calendar 2021 の 1 日目の記事です 🎅🎂 目次 # はじめに # 歴史 ## 発表 〜 正式リリース（2018/10 〜 2019/11） ## 2020 ### 1Q + α ### 2Q ### 3Q ### 4Q ## 2021 ### 1Q ### 2Q ### 3Q ### 4Q ## 2022 ### 1Q #
Priyanka VergadiaStaff Developer Advocate, Google Cloud Implement your architecture diagram for free Go from proof of concept to deployment with $300 in free credits for new customers and free usage of 20+ products. Get started for free You have a cloud use case… How do you go from idea to implementation? The first step in your implementation journey is the architecture diagram. Having an architec
開発者向けQ＆Aサイト「Stack Overflow」は2021年12月23日（米国時間）、コードコメントを書くためのベストプラクティスを紹介した。これはミルズ大学のコンピュータサイエンスの教授であるエレン・スパータス氏による寄稿記事だ。 この記事は2021年7月5日に掲載されたもので、同ブログで2021年に人気を博した記事のトップ10の1つとして再掲載された。 スパータス氏は、「コメントは、出来の悪いコードの言い訳や修正として書くものではなく、（コードが表すものと）異なるタイプの情報を提供することで、良いコードを補完するものだ」との見解を示した。その理由としてシステムアーキテクトのピーター・ヴォーゲル氏が2013年に投稿したコメントに関する3つの事実を挙げた。 （1）コメントを書いて、維持するには費用がかかる （2）コンパイラはコメントを無視するため、コメントの内容が正しいかどうか機械的
追記GitHub Sponsors で組織がスポンサーになれるようになったため、個人アカウントから組織アカウントへ切り替えました。 月 500 ドルなぜスポンサーになったのか時雨堂では自社製品のすべてのウェブドキュメントに Sphinx を利用しています。そのため Sphinx を継続的な開発を少しでもやりやすくしてもらえるようにスポンサーになりました。 個人としても Sphinx は利用させてもらっており、今まで小宮氏への個人的なスポンサーにはなっていました。 ただ今後も Sphinx を自社製品のドキュメントとして使い続けたいという思いから、企業としてメインの開発者である小宮氏への継続的なスポンサーになるべきだと判断しました。 時雨堂がスポンサーになっている開発者Cowboy や Gun の開発者である Loïc Hoguin 氏Blend2D や AsmJit の開発者である Pet
ここ最近tblsのアップデートエントリを書いていなかったのですが、最近変更をいくつか行いました。 このまま放置するとちょっと紹介しきれなくなりそうなので、ここら辺で放出しておこうと思います。 紹介時点のtblsのバージョンはv1.29.0です。 PostgreSQLでの public. スキーマ表示仕様変更 tblsでは、もともとPostgreSQLの public. スキーマ（ schema_name.table_name.column_name の schema_name ）だけ特別に非表示にしていました。 こうなっていた理由は、私がPostgreSQLでのスキーマを意識した運用経験がなかったことに寄る部分が大きいです。「デフォルトだから非表示で良いだろう」と。 ところで、tblsにはlintの機能があります。「テーブルカラムにコメントが書かれているか？」とか「外部キーの参照元にIND
Meet the modern standard for public facing documentation. Beautiful out of the box, easy to maintain, and optimized for user engagement.
Atomic PropsWrite styles with Atomic Props, rapid to develop complicated UI by composing Atomic Props. Scoped styleBorned with scoped styles, So don't worry any conflicts due to the globalnamespace. Type SafePerfect support for TypeScript, which bring Type definition,IntelliSense,Self documentation.
この記事は アウトプットはいいぞカレンダー 2022 の 15 日の記事です。 はじめに 記事を書くのは結構好きで、Qiita や Zenn にごそごそと書き続けてたら計 100 記事をとっくに超えてました。今知りました。 「はえ〜そんなにあったのか」って気持ちです。 ちなみに 7 年ほど前の初投稿は、「こういうときはこうすると楽だぞ」ってドヤ顔でコード書いたやつで、数行しか書いてないくせにバグってました。 公開後に即コメント通知が来て、恐る恐る見たら何人かバグ指摘をしてくれてました、懐かしい。 「いんたーねっとこわい、けどやさしい」って思った思い出の記事です。 それから時は経ちある程度は書き慣れて、ここ数年はそれなりに一貫した自分ルールみたいなものができてきています。 気にすることが定まっていると書くとき楽なので、ちょっと整理して晒してみたいと思います。 ネタにしつつあわよくば自分ルール
社外にも公開しているSmartHR Design Systemは、ライティングに関するガイドラインも充実しています。この記事では、UI文言を検討したいと思ったときにそれらのガイドラインをどのように活用するとよいのか、おすすめの参照方法を紹介します！ チェックリスト的に参照したいライティングスタイル ライティングスタイルには、UI文言に限らずヘルプページやリリースノートなどにも適応したいガイドラインがまとまっています。 基本的かつ具体的な内容で、数も多くないので都度チェックリスト的に参照するのがおすすめです！ヘルプページやリリースノートも含めて、開発に関わる文言や文章を書く機会に参照すると、自然と頭に入っていきます。 迷ったときに参照したい用字用語
Linux command line for you and me is a book for newcomers to the command line environment. Feedback is greatly appreciated. If you have any questions, comments, random praise, or anonymous threats, shoot me an email. Useful Links lym @ GitHub Issue Tracker
こんにちは! ソウゾウのSoftware Engineerの@ogataka50です。連載：メルカリShops 開発の裏側 Vol.2の9日目を担当させていただきます。 9日目はメルカリShopsを開発する中でのDesign Docsの運用について紹介させて頂きます。 Design Docsとは Design DocsとはGoogleなどで取り入れられているシステム設計ドキュメント手法です。開発をする前にプロジェクトの背景や目的、設計、検討した代案などをdocument化します。そしてそれを持って関係者との共有、議論を行うことによって事前に全体を考察し、精度を高め開発後の手戻りを減らすなどが主な目的になります。 例として、GoogleでのDesign Docsについては下記にまとめられています。 Design Docs at Google メルカリShopsでのDesign Docsのte
jsDocs.io is a documentation host for Javascript and Typescript packages published on npm
こんにちは。SRE の @chaspy です。 以前、Production Readiness Checklist に関する記事を書きました。 quipper.hatenablog.com Production Readiness Checklist の運用開始から1年ほどの月日が経ち、27ものサービスが無事 Production へ出ていきました。 サービスを安心して Production へリリースするために役立っている Production Readiness Checklist ですが、Product Team がこの Check List を進める上でいくつか課題がありました。 本記事では、Production Readiness Checklist 運用開始後に、どのような改善が行われてきたのか、その内容と方法を説明します。また、1年以上の運用を通して、Production R
Artificial LIfe ENvironment (ALIEN) is an artificial life simulation tool based on a specialized 2D particle engine in CUDA for soft bodies and fluids. Each simulated body consists of a network of particles that can be upgraded with higher-level functions, ranging from pure information processing capabilities to physical equipment (such as sensors, muscles, weapons, constructors, etc.) whose execu
Today we are extremely happy to finally announce Docusaurus 2.0! 🥳️ At Meta Open Source, we believe Docusaurus will help you build the best documentation websites with minimal effort, letting you focus on what really matters: writing the content. After 4 years of work, 75 alphas and 22 betas, the next generation of Docusaurus is ready for prime time. From now on, we now plan to respect Semantic V
Matt Pearring and Dmitri Shuralyov 16 February 2021 Today the Go team is very happy to announce the release of Go 1.16. You can get it from the download page. The new embed package provides access to files embedded at compile time using the new //go:embed directive. Now it is easy to bundle supporting data files into your Go programs, making developing with Go even smoother. You can get started us
If you’ve accessed the MDN website today, you probably noticed that it looks quite different. We hope it’s a good different. Let us explain! MDN has undergone many changes in its sixteen-year history from its early beginning as a wiki to the recent migration of a static site backed by GitHub. During that time MDN grew organically, with over 45,000 contributors and numerous developers and designers
ドキュメントが欠かせない理由欧米の企業とお仕事するときにいつも感心するのがドキュメントのボリュームと質。私も結構書く方だと思っていますが、それを容易に上回る情報量のドキュメントが共有されることがあります。ただ単に文字数が多いわけではなく、必要十分な情報が図なども交えて明文化されています。 エンジニアに限らず、デザイナーやプロダクトマネージャーもしっかりドキュメントを書く習慣が根付いているように見えます。恐らく下記の理由からしっかりドキュメントを書かざるを得ないのかもしれません。 皆が同じ時間帯で仕事をしているわけではない場所も違うので「ちょっと話してすり合わせ」とはいかない英語が第一言語ではない人たちとコミュニケーションをしている文化も違うのでお互いがもつ『当たり前』が通じない日本企業で日本語で通じ合える環境では馴染みがない状況です。ドキュメントを書かなくても、ちょっと話せば分かり合える場
リリースノートとは、ソフトウェアのリリース時に機能や目的などを知らせるための資料であり、ソフトウェアがアップデートされる場合も機能強化や不具合修正に関する情報をリリースノートとして公開します。リリースノートの中には優れたものもあれば悪いものもあるとのことで、「よいリリースノートを書くための10のポイント」について、ソフトウェア開発者のサイモン・ウィルソン氏がまとめています。 Writing better release notes https://simonwillison.net/2022/Jan/31/release-notes/ ウィルソン氏は、「リリースノートはオープンソースプロセスの重要な部分です」と述べ、GitHubなどでオープンソースのプロジェクトをリリースする場合、リリースノートを適切に書くことが大切だと主張しています。最近、「よいリリースノートの書き方」について考えていた
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
dummy GA 新しいURLに転送しています… https://stockmark-tech.hatenablog.com/entry/2023/12/14/170000...
UMLをテキストベースで記述できるPlantUMLを使っている方は多いのではないでしょうか。クラス図を流用する形でER図も描くことができます。そして、データベースはすでにあり、そこからPlantUML用に出力できればいいのに、と考えている方もまた多いでしょう。 そんな方にお勧めなのがplant_erdです。各種データベースに対応したER図エクスポートソフトウェアです。 plant_erdの使い方 出力した内容をPlantUMLで表示しています。 plant_erdはSQLite3、MySQLそしてPostgreSQLに対応しています。各データベースの内容をそのままPlantUML向けに出力が可能です。特定のテーブルだけを出力対象にもできます。リレーションも再現され、データベース構造をドキュメントに書き出すのにぴったりです。 plant_erdはGo製のオープンソース・ソフトウェア（MIT
AppleやGoogleといったOSを開発するメーカーは、自社プラットフォーム向けのアプリをリリースする開発者向けに、どのようにデザインを構築していけばいいのかをまとめたガイドラインを作成し公開しています。Appleの「Human Interface Guidelines」は、言葉・画像・デザインをどのように選択すればユーザーが簡単にコンテンツや機能を使えるようになるかをまとめたもので、開発者だけでなく多くの人にとって参考になる内容が多く含まれたものとなっています。 Inclusion - Foundations - Human Interface Guidelines - Design - Apple Developer https://developer.apple.com/design/human-interface-guidelines/foundations/inclusion
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
僕は、人生のかなりの時間と労力と情熱を文書処理に費やしました。なので、文書処理のことを書いたり話したりしたことはあります。ですが、文書処理の実際のプロジェクトやソフトウェアの話をしたことはありません。守秘義務の問題もありますし、仮に守秘義務に引っかからなくても進行中のプロジェクトについて口にすることはありません。 しかしながら、10年20年も昔の話なら、もはや誰にも迷惑はかからないし、気にする人もいないでしょう。技術的なアイディアで具体性があるものは特許になっているし、抽象的一般的な方法論は、むしろパブリックにすべきものでしょう。 僕がそのテの話をしなかった一番の理由はメンドクサイからです。そして、懐旧談に意味があるとは思えないからです。ごく最近、ふとしたキッカケから、個人的体験を縷々述べることに意味はないが、10年20年前に考えたりやったりしたことを書き残しておくことはまんざら無駄でもな
1st October 2022 Gergely Orosz started a Twitter conversation asking about recommended “software engineering practices” for development teams. (I really like his rejection of the term “best practices” here: I always feel it’s prescriptive and misguiding to announce something as “best”.) I decided to flesh some of my replies out into a longer post. Documentation in the same repo as the code Mechani
To receive the latest developer news, visit and subscribe to our News and Updates.
この記事ははてなエンジニアのカレンダー | Advent Calendar 2021 - Qiita 2日目の記事です。 最近、データパイプラインの整備や営業チームの人力混じりの運用フローを機械化するなどの業務改善に取り組んでいます。 その過程で、運用ドキュメントを読んだりヒアリングして図を描くことがよくあります。 描いた図をもとに「この流れであってますか?」と確認したり「ここ手間結構かかってそうですが困ってませんか?」とコミュニケーションをします。暗黙的な業務の流れが明確になるだけでなく、改善点の発見にも繋がります。 ひととおり改善タスクが終わった後にも図を最新にします。ドキュメントと併せて成果物とします。 どんなデータがあってどのようにビジネスに使われているか、データがどのように取得&保存されているかを残しておくのは今後のデータ活用や改善のためにも必要です。 俺はそんな個々の業務のデー
ChartDB is a powerful, web-based database diagramming editor. Instantly visualize your database schema with a single "Smart Query." Customize diagrams, export SQL scripts, and access all features—no account required. Experience seamless database design here. What it does: Instant Schema Import Run a single query to instantly retrieve your database schema as JSON. This makes it incredibly fast to v
We are excited to introduce Next.js 10.1, featuring: 3x Faster Refresh: 200ms faster refresh with no changes necessary. Improved Installation Time: 58% smaller install size and 56% fewer dependencies. next/image Improvements: Apple Silicon (M1) Support, plus more layout and loader options. Next.js Commerce Shopify Integration: Flexible data layer for composable e-commerce apps. Custom 500 Page: Ad
Markdownで記述できるドキュメント生成ツールを探していたところFacebook製のDocusaurusというツールを知りました。導入して試してみましたので紹介します。 こんにちは。サービスグループの武田です。 Markdownで記述できるドキュメント生成ツールを探していたところDocusaurusというツールを知りました。簡単ですが導入して試してみましたので紹介します。 Docusaurusとは DocusaurusはFacebook製のドキュメント生成ツールで、主にOSSのマニュアルやお知らせなどのブログを管理するために使われているようです。次のような特徴があります。 MarkdownおよびJSXを含んだMDXでコンテンツを作成する 生成したドキュメント（サイト）はReactで動作し、カスタマイズも容易 多言語対応（ローカライズ）も可能 ドキュメントのバージョニングが可能で、プロダ
AI & MLLearn about artificial intelligence and machine learning across the GitHub ecosystem and the wider industry. Generative AILearn how to build with generative AI. GitHub CopilotChange how you work with GitHub Copilot. LLMsEverything developers need to know about LLMs. Machine learningMachine learning tips, tricks, and best practices. How AI code generation worksExplore the capabilities and be
RFCs - requests for comment - or Design Docs are a common tool that engineering teams use to build software faster, by clarifying assumptions and circulating plans earlier. There are some similarities between writing automated tests for your code, and writing RFCs before you start working on a non-trivial project: Software engineers who write tests for their code - and ask for code reviews on it -
Why was “source” chosen? MySQL Asynchronous Replication is a change stream. Each replication configuration has a source and does not imply what role a server should have in the overall database architecture. Therefore, the use of e.g. “primary” does not fit, especially when replication is used to build database architectures topologies including bidirectional replication, multi-tiered replication,
Sign up for a Google Workspace account. Create a Google Cloud project. Enable the following APIs for Google Workspace APIs Admin SDK API (optional, if enabling Google Groups as document approvers) Google Docs API Google Drive API Gmail API People API Also, to enable searching for users, the Google Workspace domain admin needs to enable external directory sharing. See more details: https://support.
docs/ @docs-owners docs/another-dir/ docs/another-dir/ @another-team 背景 GitHub のコードオーナーは、プルリクエストを作成した際に自動的にレビュワーをリクエストすることができる機能です。 CODEOWNERS という名前のファイルをリポジトリに配置し、.gitignore と似たような構文でディレクトリと対応するオーナーを指定します。詳しくは以下のドキュメントに記載されています。 CODEOWNERS を利用する上で、「特定のディレクトリのオーナーを指定しつつ、一部サブディレクトリだけ別のオーナーを指定したい」という状況がありました。 docs/foo-dir/file.txt ... @docs-owners docs/bar-dir/file.txt ... @docs-owners docs/another-
【roff形式を手書きは無理ゲー】manページをMarkdown + Pandocで作成【with manページお作法】 by nao · 公開済み 2020年12月19日 · 更新済み 2020年12月25日 前書き：manualページは伝統的なドキュメント manページは、UNIX系OSのドキュメントであり、コマンドやシステムコールなどの説明が記載されています。 Unix v7の時代（1979年）から変化が少ないため、2020年現在の視点で見ると表現力に難があります。具体的には以下のような欠点があり、manページを良質なドキュメントとするには文章力を試されます。 画像を挿入できない ハイパーリンク非対応 Terminalからしか参照できない（manページをHTMLに変換して公開しているサイトはあります） 勿論、manページより表現力が高いTexinfo、Docbookなどの代替ドキュメ
こんにちは。ノバセルのデータプロダクトチームにて開発エンジニアをやっている山中（yamnaku_）です。 現在は、ノバセルの各種分析システムのバックエンド開発を行なっています。 特に、データウェアハウス製品Snowflakeを利用したデータ基盤の開発・運用に取り組んでいます。 私の所属するチームでは、意思決定を記録するドキュメントとして、Architectural Decision Record（ADR）の運用を始めて3ヶ月ほどが経ちました。 今回は、感じることが出来た効果についてご紹介したいと思います。 背景と課題 採用したフォーマット ドキュメントオーナーと変更履歴 ドキュメントの目的 背景 概要 詳細 3ヶ月の運用の結果 呼び方の問題 より良い目的設定や、多くの選択肢が出てくるようになった 意思決定に関する自信の醸成と型化 ビジュアルの活用 まとめ 背景と課題 ひとつ目のプロダクトで
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
