VSCodeの拡張機能、なに使ってますか？ はてなエンジニア世論調査 #2 - Hatena Developer Blog
こんにちは、Webアプリケーションエンジニアのid:hogashiです。 半年ほど前に公開した「開発環境のフォントなに使ってますか？」に続く、はてなエンジニア世論調査の第2回「VSCodeの拡張機能、なに使ってますか？」です。 ソースコードエディタであるVisual Studio Code（以下、VSCode）は多くのエンジニアに利用されています。VSCodeにはソースコードのシンタックスハイライトやデバッグなど、さまざまな拡張機能をインストールして使うことができますが、公開されている拡張機能は膨大にあります。 その中から、はてなのエンジニアはどんな拡張機能をインストールして、日頃の開発に使っているのでしょうか？ 前回と同様にアンケート調査してみました。 アンケート方法 アンケート結果から見える人気の機能拡張 6割の拡張機能は1人だけが使用 人によってかなり異なるインストール数 興味深いコ
（9月3日追記）元のタイトルは「行政文章はMarkdownで管理できるか」でしたが、ここで言っているのは「文章」ではなく、「文書」だろう、というご指摘をいただき、本文も含め訂正させていただきました。（追記終わり） 先日下記のTweetをしたところ、多くの人からコメントをいただきました。 行政文章のMarkdown化、進めていきたい。公開時だけでなく、普段からMarkdownでやりとりできるといいんだけどな。Wordを使って文章作ってる人をターゲットにしたMarkdownエディタを作ってみたい。 HackMDでもまだ難しいイメージ。実務に寄せていく必要がある。https://t.co/3iVDjXVHcQ — Hal Seki (@hal_sk) August 31, 2021 賛同の意見が多かったのですが、下記のような懸念点もいただきました。 ・編集する側も見る側も大変になる。何故やる必要
よくあるAWSサーバーレス構成のシーケンス図をMarkdown（Mermaid）で描いてみた | DevelopersIO
こんにちは、CX事業本部 IoT事業部の若槻です。 今までシステムのドキュメントなどでUML図を使用したい場合は、別途PlantUMLで書いて画像ファイルを生成し、MarkdownやAsciiDoc内に配置するということをしていました。 しかしこちらの記事の通り、Mermaidを使用すればMarkdown内で直接UML図の定義をコードで記述し、さらにGitHub上ではそのまま描画までしてくれるとのことです。知らなかった…！ GitHubでmermaid記法が使えるようになったのでアーキテクチャーの図を書いてみた | DevelopersIO そこで今回は、下記のようなよくあるAWSサーバーレス構成（API Gateway + Lambda + DynamoDB + α）のシーケンス図をMermaidで描いてみました。 描いてみた Mermaidにおけるシーケンス図の文法はこちらを参考にしま
JavaScript Promiseの本 v2リリース、ES2015+に対応、Async Functionの章を追加 JavaScriptのPromiseについて学ぶ書籍であるJavaScript Promiseの本 v2をリリースしました。 Promise本 1.0.0をリリースしたのは2014年6月ですが、そこから少しづつアップデートしていました。 JavaScript Promiseの本を書きました | Web Scratch ES6がリリースされたのでPromiseについて学びましょう | Web Scratch 今回のメジャーアップデートとなる2.0.0では、サンプルコードのコードベースをES2015前提のものへと変更しています。 1.x系からの主な変更点としては次のものがあります。 ES6をES2015に表記を変更 コードベースをES5からES2015+(ES2015以降ベース
本稿では、gihyo.jp編集部で利用しているMarkdownファイルの記述方法を主に解説します。 注意：gihyo.jp編集部内でのみ採用しているMarkdownの書き方をまとめた文書を、記事の体裁を取って公開したものです。なお、記事公開後に記述方法を追加・変更する可能性もあります。 Markdownとは？ はじめに、筆者の把握している範囲でMarkdownについて概説しておきます。 近年は一般向けのウェブサービスやテキストエディタでも利用されてきているMarkdown。端的に言えば、テキストファイル上で文書を書くための構文です。文書の読みやすさに焦点を当てており、Markdown形式のテキストファイル（＝Markdownファイル）をそのまま見れば文書とその構造が理解できるように、Markdown特有の編集記号や字下げを用いて表現します。また、MarkdownファイルをHTMLファイルに
私のチームで行っているドキュメント管理方法の紹介(GitHub Actions, S3, AsciiDoc) | DevelopersIO
ドキュメントツールのインストール(Windows) Macの場合の設定方法は、本項の後に記載 PowerShellの起動 各種ツールをインストールするため、PowerShellを管理者として実行 Windowsボタンを押下 powershell と入力 右クリックで管理者として実行 を選択します Chocolateyのインストール 本手順は前述で起動したPowerShellを利用 1.Chocolatey のサイトにアクセスし、インストールコマンドをクリップボードへコピー 2.前項でコピーしたコマンドをPowerShellにペーストして実行します Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServiceP
JavaScript Primer 改訂2版をリリースしました！/JavaScript Primerはなぜ更新され続けるのか？ JavaScriptの入門書であるJavaScript Primer 改訂2版 迷わないための入門書がリリースされました。 書店やオンライン書店で購入できます。 KADOKAWA: 「JavaScript Primer 改訂2版 迷わないための入門書」azu [ＰＣ・理工科学書] - KADOKAWA Amazon: JavaScript Primer 改訂2版 迷わないための入門書 | azu, Suguru Inatomi |本 | 通販 | Amazon 楽天: 楽天ブックス: JavaScript Primer 改訂2版 迷わないための入門書 - azu - 9784048931106 : 本 ヨドバシ: ヨドバシ.com - JavaScript Pri
週に一度まとめて更新のようなパターンだと、体調が悪いときなどにその週はスキップされ、また次の週も更新しようとして偶然タイミングが合わなかった場合などに、1ヶ月更新が止まるみたいな状態は起きやすいです。 1ヶ月更新を止めてしまうと、そこで更新する習慣が失われて、この書籍でいう逆戻りが起きるのかなと思っています。 そのため、JSer.infoではタスクを細分化して進められる時にやっていけるような形を作っています。 ライブラリのメンテナンスのリズムをツール化する JavaScript周りは顕著ですが、ライブラリが細かく分かれていることが多いため、リポジトリの数も多いです。 そのため、リポジトリのCI設定や依存ライブラリのアップデートなどをメンテナンスするだけで無限の時間がかかります。 このメンテナンス作業を手動で毎回やるととても疲れるので、自分の場合はツール化していることが多いです。 作ったり、
技術書を書く技術 - Qiita
Intro こちらの技術書を執筆しました。15Stepで踏破 自然言語処理アプリケーション開発入門 本稿は書籍そのものの紹介ではなく、私が技術書を執筆するために利用した技術・用意した環境についての解説です。 私が執筆を始めた当時（2017年下旬）はWebを漁ってもあまり技術書執筆のノウハウがなく、本稿の内容も割と手探りでした。今ググってみると技術書展のおかげで大量に情報が出てきますね。それらと被る部分もありそうですが、自分が１冊書いてみて得たノウハウみたいなものをここに吐き出してみたいと思います。 執筆フォーマットの決定 まずは執筆に使うツールを決めます。 商業誌の場合、出版社（編集者）がそのフォーマットでの入稿を受け付けてくれるかどうかにも依るため、執筆者の一存で決められないこともあるようです。 私の場合は幸運にも、こちらの希望に合わせてくれる編集者が入ってくれました。 色々調べて↓あた
はじめに ひょんなことから React 公式ドキュメント日本語版のメンテナをやらせていただいています smikitky です。 この記事は、React 公式ドキュメントの翻訳作業が GitHub ベースでどのように行われているのかを解説したものです。ドキュメントの翻訳には色々な方法がありますが、React の現アプローチは非常に上手く行っていると個人的に考えています。部分的には似たアプローチを説明している既存記事も探せばありますが、少し詳しめに書くことで事前の不安を取り除き、「思ったより簡単そうだから、自分もあのライブラリのドキュメント翻訳をやってオープンソースに貢献してみよう」と思えるようになることを目標にしています。 想定読者は Git、GitHub、Markdown（ないし類似の軽量マークアップ言語）、および基本的な HTML の仕組みがわかる開発者です。何らかの静的サイトジェネレー
Spring Modulith でモジュラモノリスなアプリの構造を検証してみた - Taste of Tech Topics
アクロクエスト アドベントカレンダー 12月9日 の記事です。 普段は Java, Python でバックエンドの開発をしている大塚優斗です😃 最近は Spring フレームワークのメジャーアップデートなどで盛り上がっていますね！ 10月にこんな記事を見かけて、Spring Modulith がとても気になっていたので、手元で試したことを書いていきます✍️ Spring Modulith とは Spring Modulith でできること 0. Spring Modulith でのパッケージの扱いについて 1. モジュール構造の検証 循環参照の検知 別モジュールへのアクセス違反の検知 2. モジュールに閉じた結合テスト 単一のアプリケーションモジュールで結合テストができること Bootstrap モードによって、結合テスト時に他モジュールの Bean 生成ができること 3. イベントによ
ものすごい種類の文書ファイルを他形式に変換できる「Pandoc」レビュー、MarkdownからLaTex、EPUBにまで対応
Microsoft WordやMarkdownで文書ファイルを作成し、それをHTMLファイルやPDFファイルに変換したい時、形式ごとにいちいち変換ソフトを用意するのは面倒です。無料のオープンソースソフトウェア「Pandoc」を使うと、ありとあらゆる形式の文書ファイルを他形式の文書ファイルに変換することができます。 Pandoc - About pandoc https://pandoc.org/ GitHub - jgm/pandoc: Universal markup converter https://github.com/jgm/pandoc Pandocは2006年にリリースされた非常に長い歴史を持つ文書変換ツールで、2020年現在でも活発な開発が行われています。変換できる文書ファイル形式の多様さから研究者やエンジニアに広く支持されており、記事作成時点でPandocが対応している文
GitHub - xwmx/nb: CLI and local web plain text note‑taking, bookmarking, and archiving with linking, tagging, filtering, search, Git versioning & syncing, Pandoc conversion, + more, in a single portable script.
nb is a command line and local web note‑taking, bookmarking, archiving, and knowledge base application with: plain text data storage, encryption, filtering, pinning, #tagging, and search, Git-backed versioning and syncing, Pandoc-backed conversion, [[wiki-style linking]], terminal and GUI web browsing, inline images, todos with tasks, global and local notebooks, organization with folders, customiz
技術書を書く技術 - Qiita
Intro こちらの技術書を執筆しました。15Stepで踏破 自然言語処理アプリケーション開発入門 本稿は書籍そのものの紹介ではなく、私が技術書を執筆するために利用した技術・用意した環境についての解説です。 私が執筆を始めた当時（2017年下旬）はWebを漁ってもあまり技術書執筆のノウハウがなく、本稿の内容も割と手探りでした。今ググってみると技術書展のおかげで大量に情報が出てきますね。それらと被る部分もありそうですが、自分が１冊書いてみて得たノウハウみたいなものをここに吐き出してみたいと思います。 執筆フォーマットの決定 まずは執筆に使うツールを決めます。 商業誌の場合、出版社（編集者）がそのフォーマットでの入稿を受け付けてくれるかどうかにも依るため、執筆者の一存で決められないこともあるようです。 私の場合は幸運にも、こちらの希望に合わせてくれる編集者が入ってくれました。 色々調べて↓あた
March 23, 2020 Please don't write your documentation in Markdown Please don't write your documentation in Markdown. Please. I'm begging you. Markdown is tolerable for short documentation, like a readme.md. Past that, it's the wrong tool for the job. Markdown is about formatting, not information Markdown is just a way to write simpler, nice looking HTML. There is direct mapping between _foo_ and <e
プロジェクトの各種ドキュメントをExcelではなくMarkdownで作ってみた - 聞こえないJavaエンジニアが適当に書き連ねていく
これは何 プロジェクトの知見共有や手順書を共有する時に、Excelではなくてmarkdownで書いたWebsiteを使ったことの振り返り。 注意 Excelを全く使わなかったのではなく、主な資料をExcelではなくてWebsiteにした。補助資料をExcelで作ったものもある。 なぜExcelにしなかったのか 過去のプロジェクト経験を基にExcelを使うことのメリットとデメリットを比較した時、Excel以外の方法を試してみる価値はあると考えた。 Excelのメリット 画像の貼り付けや吹き出しの付与が簡単 文字の装飾が簡単 印刷することを想定しなければ、見た目を整えるのが非常に楽 Excelのデメリット ファイルをどこに置いてあるか探しにくい ファイル内部の文言検索がやりにくい 画像を大量に貼り付けるとファイルサイズが大きくなる 修正した時、差分の確認がほぼ不可能 Markdownで資料を作
AppBrew で LIPS のリードエンジニアをしている @spinute です。 突然ですが、みなさん、コマンドラインは好きですか？ 私は好きです。好きなコマンドは tldr, glances, tig で、よく使うコマンド Top-10 はこんな感じです。1 $ history | awk '{print $2}' | sort | uniq -c | sort -nr | awk 'NR<=10 {print $2}' | cat -n 1 git 2 vi 3 fg 4 tig 5 l 6 cd 7 grep 8 curl 9 aws 10 go ストイック・ハードボイルド路線ではなく、シンプルで安定したインターフェースを提供しながらも、認知上の負荷を下げてくれるリッチなコマンドが好きです。 AppBrew では、ウェブ生まれアプリ育ちの人が多めだったり、ソフトウェアエンジニアの
AsciiDocを利用してエンジニアのナレッジを上手に集約しよう | cloud.config Tech Blog
はじめに 流用性・検索性が高いドキュメントの作成は今後のエンジニアに求められるスキルの一つです。 一方で社内ではPowerPointやWordによるドキュメント作成が頻繁に行われる事が多いのではないでしょうか？PowerPointやWordは即時性が高いフォーマットですが、流用性・検索性を確保し続ける事が困難です。 エンジニアが気軽に出版レベルのドキュメントを作成したり、Wikiより管理の容易なナレッジを作成するのに役立つAsciiDocをご紹介するとともに、より柔軟な運用について提案したいと思います。 目次 AsciiDocとはAsciiDocの記述方法AsciiDocを利用すべき理由社内ドキュメントとの共存編集中のAsciiDocをプレビューするにはAsciiDocでHTMLやPDF等を出力するにはAsciiDocとは AsciiDocは軽量マークアップ言語の一つで可読文書記述形式です
技術書、ブログ、READMEを書いてていて、文章中に出てくるコードブロックのコードをテストしたいことがあると思います。 そのサンプルコードが本当に動いてるのか不安になることがあるからです。 power-doctestは、そのコードブロック中のコードにコメントを入れるだけでテスト可能にするツール群です。 power-doctestの例 具体的な例から見ていきます。 次の例では、Markdownで説明とJavaScriptのコードブロックを書いています。 デフォルト引数を使って書くことで、このような挙動は起きなくなるため安全です。 デフォルト引数では、引数が渡されなかった場合のみデフォルト値が入ります。 ```js function addPrefix(text, prefix = "デフォルト:") { return prefix + text; } // falsyな値を渡してもデフォルト
はじめに これは、『BASIC×SHADER: Unityで学ぶシェーダープログラミング』というシェーダー本 (Kindle) を書いて得た知見のまとめです。 本の概要を「文章」にすると、 本書は、これからシェーダープログラミングを学びたい方を対象にした入門書です。シェーダーの事前知識は不要ですが、「何かしらのプログラミング言語」と「高等学校程度の数学」の理解を前提としています。 取り扱っている内容は、次のとおりです。 シェーディング言語 (Cg) の基礎文法 シェーダープログラミングのためのベクトルと行列の復習 ライティング/テクスチャリング/シャドウ/フォグ/ポストエフェクトの基礎実装 「画」にすると、 こんなかんじです。上記のシェーダーは全て GitHub で配布しているので、学習にご活用ください。 成果物 BASIC×SHADER (Kindle) BASIC×SHADER (Gi
2004年中途入社の koic です。来月で入社17年。長いですね。 17年の間で人や技術が流転する長い勤務の中で伝承の途切れを観測していることから、私がいまの勤務先に入ったころ Wiki への考え方への影響を受けたものを発掘してみました。今回、私的解釈を交えて一般公開します。 はじめに 『ドキュメント記述の心構え』原文 私的解釈 {{toc}} 木構造よりも、ネットワーク構造を好め ネストしたリストよりも、見出しによる構造化を好め リストで文章を区切るよりも、空行をあけてPタグでレンダリングせよ 安易に項目追加する前に、リオーガナイズを検討せよ 正規化と重複の均衡点を探せ PREとQUOTEを使い分けよ リオーガナイズのメカニクスを用意せよ おわりに はじめに 本記事で取りあげるのは 2006年以前に「ドキュメント記述の心構え」 (WikiName は DeciplinesOfWriti
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter. GistPad 📘 GistPad is a Visual Studio Code extension that allows you to edit GitHub Gists and repositories from the comfort of your favorite editor. You can open, create, delete, fork and star gists and repositories, and then seamlessly begin editing files as if they were local, without ever cloning, pushing or pulli
【12/24にGitLab対応!】テキストで自在に「描く」- KrokiではじめるDiagram as Code - Qiita
【12/24にGitLab対応!】テキストで自在に「描く」- KrokiではじめるDiagram as CodeMarkdownGitLabasciidocVisualStudioCodekroki これは、 NTTコミュニケーションズ Advent Calendar 2020 25日目の記事です。 昨日は @tnoyama さんの「TEKTONとArgoを比較してみた」でした。お楽しみいただけましたか？ Krokiとは 本記事では、テキストからの図表生成ツール Krokiを紹介します。最新バージョンは0.9.0です。 公式docs: Kroki! GitHub: yuzutech/kroki: Creates diagrams from textual descriptions! 概要 Kroki!は、テキストから統一的なAPIで、 UML C4 データ可視化 その他図表 を、PNG,
Please don’t upload my code to GitHub This is a call to open source developers to not upload the work of others to GitHub. What’s the problem with GitHub? Well, there are a lot of problems with GitHub. Here, we will mainly focus on a feature called Copilot, but if you’re interested to learn more about the others, please visit this page. What is Copilot? According to GitHub, GitHub Copilot is an AI
はじめに prismatix事業部の中村です。 私が開発に携わっているEC/CRMのWebAPIプラットフォーム prismatix では検索サービスを提供しており、その内部では Elasticsearch を利用しています。 今回イチから Elasticsearch を勉強する機会がありましたので、構築方法や使い方を書いていこうと思います。 Elasticsearchとは Elastic社が提供している Elastic Stackというプロダクト群に含まれる、分散処理が可能検索及び分析エンジンです。 Elastic Stack には、下記のプロダクトが存在します。 Elasticsearch ： 心臓部となるJSONベースの検索/分析エンジン Kibana : 検索、可視化用のUI Beats ： アプリやインフラの統計情報等のデータ収集ツール Logstash ： データ収集パイプライ
AsciiDocのコメントを用いて文中にFIXMEを仕込む。 その他のFIXME（全般的なものなど）をここにリストにする。
話題の組版エンジン Typst を触ってみた
Typst — 新しい組版エンジン 今年の3月21日、Typst というソフトウェアが public beta となり、処理系がオープンソースで公開されました。 Typst is a new markup-based typesetting system for the sciences. Typst はマークアップベースの新しい組版システムです。独自の構文を持っており、Typst で書かれた文書をオンラインサービスまたはローカル上でコンパイルすることで PDF に変換（出力）することができます。 公式サイトには「科学分野向け」「LaTeX への不満から生まれた」とあり、数式や相互参照等の機能が充実していることから、メインターゲットも LaTeX ときわめて近いところにあると考えられます。とはいえそれ自体は汎用的な組版システムなので、用途も 論文・会議原稿 雑誌の記事 小説 技術書 スライ
GitHub PagesのSourceにGitHub Actions(beta)を指定し、AsciiDocとSwaggerUIを公開する構成 | DevelopersIO
※ リポジトリのページから「Settings」->「Source」設定確認可能 Source指定にDeploy From a branchと比較し、GitHub Actions(beta)を利用するメリットには以下があります。 ホスティングのために用意しているブランチやビルド成果物が不要になり、認知負荷を下げられる ビルド資材をコミットする作業がなくなる ビルド資材の容量が大きい場合、pullやcheckoutにかかる時間を削減できる(モノレポの場合コードに対するCIにも影響する) 設定方法 前提 今回は以下をホスティングする想定にします。 Swagger UI AsciiDoc with PlantUML 何らかのHTTP REST APIの仕様書を作る想定です。 リポジトリテンプレート リポジトリテンプレートは公開しています。用途に応じてカスタマイズして頂けたらと思います。 ファイル/
問題 DeepL Pro のウェブサイト翻訳は便利ですが、プログラミング関連の記事に適用すると以下のようにソースコード等の翻訳されてほしくない箇所まで翻訳されてしまい、翻って読みづらくなります。 解決策 DeepL にはHTML中に class="notranslate" もしくは translate="no" 属性があると、その範囲を翻訳しないという仕様があります（Google翻訳由来の仕様らしい）。 DeepL API: Disabling translation of elements そこでTampermonkeyを使って、以下のような UserScript で翻訳したくないタグに class="notranslate" を追加して、再度 DeepL を適用します。 // ==UserScript== // @name add-notranslate-class-to-code-r
GitHub Trending RSS
GitHub Trending RSS Star The latest build: 7 October, 2023 All Languages Unknown Languages Unknown languages 1C Enterprise 2-Dimensional Array 4D ABAP ABAP CDS ABNF ActionScript Ada Adblock Filter List Adobe Font Metrics Agda AGS Script AIDL AL Alloy Alpine Abuild Altium Designer AMPL AngelScript Ant Build System Antlers ANTLR ApacheConf Apex API Blueprint APL Apollo Guidance Computer AppleScript
はじめに 流用性・検索性が高いドキュメントの作成は今後のエンジニアに求められるスキルの一つです。 一方で社内ではPowerPointやWordによるドキュメント作成が頻繁に行われる事が多いのではないでしょうか？PowerPointやWordは即時性が高いフォーマットですが、流用性・検索性を確保し続ける事が困難です。 エンジニアが気軽に出版レベルのドキュメントを作成したり、Wikiより管理の容易なナレッジを作成するのに役立つAsciiDocをご紹介するとともに、より柔軟な運用について提案したいと思います。 AsciiDocとは AsciiDocは軽量マークアップ言語の一つで可読文書記述形式です。 出力もHTML, PDF, ePubなどが行えるため個人での出版活動から開発環境でのナレッジの共有まで様々な用途で利用する事が可能です。 AsciiDocの記述方法 軽量マークアップ言語でメジャーな
soupault
Soupault (soup-oh) is a static website generator/framework that works with HTML element trees and can automatically manipulate them. It can be described as a robotic webmaster that can edit HTML pages according to your rules, but doesn’t get tired of editing them. You can use soupault for making blogs and other types of websites, pretty much like any other SSGs (Jekyll, Hugo, Eleventy, etc.). Howe
こんにちは、デジタルペンテスト部のねいちゃーどです。 普段は チート対策ペネトレーションテストサービス の診断員として、主にゲームに関わるサービスの脆弱性診断を担当しています。 私たちのチームでは、お引き受けさせていただいた案件に対する成果物として「報告書」を作成・提出しています。 報告書には「発見した脆弱性についての詳細なレポート」などが記載されています。 端的に還元すれば「報告書を作成するのが本業」と言っても過言ではありません。 その報告書の作成には以前まで Microsoft Word (以下、Word) を用いていました。 しかし Word を用いた報告書作成には、以下の問題がありました。 共同編集機能を用いた際に、編集内容が競合することがある その結果、同ファイルをリネームして上げ直さないといけなくなったり、代表者がローカルに落として編集した事例が過去にあった 「【最新版】打ち合
今までドキュメントは適当なMarkdownで書いてそれを適当にGitBookでウェブサイトに変換していた。だがGitBookはコマンドラインツールの開発をやめてしまっている。なのでGitBook公式のホスティングサービスに移行するか、何か代替品を探さなければならない。というわけで探しているのだが……。 既存のGitBook用ファイルを使いまわしたい 何に移行するにしても少しの手直しは必要になるのである程度は我慢。 このためにAsciiDocとかLaTeXはとりあえず除外 数式が書ける これは（mathjax/katexの違いはあれど）大抵のものがクリアしている HTMLが出力できる 基本的に全てが対応している。 PDFも出力できる 全然誰も興味がないらしい……誰も対応していない……。 ヒントボックスとかが欲しい テンプレート機能があればなんとかなるが、あったほうが圧倒的に楽。 多言語対応（
※ 正確には「知った」のは恐らく半年以上前なんだけど、ちょっと触ったりドキュメントを読んだりした。 設計の基準を明確にして残しておきたい自分の問題意識としては「設計の決定のための検討、比較などの記録が issue や pull-req に埋れがち」というものがある。またこれらは実はそれほど検索しやすくないし、記録を遡ることもやりやすくない。 この問題は実はかなり長いこと意識としては持っていて、何かみんな困っているはずなんだけどなーと思いつつ、全然情報が見つからずに思い出しては放置、思い出しては放置していたのだが、今回の直接のきっかけは以下のツイート。 考えつつ手を動かす方が問題とちゃんと向き合えてて良いでしょって思ったらちゃんと「問題の分解の仕方を考える」って出てきた。教えるときに参照しやすくてめっちゃ良い！ https://t.co/kjkawSiNJM — Takafumi ONAKA
これは「TeX ＆ LaTeX Advent Caleandar 2020」の23日目の記事です。 22日目は、MusicDumpさんでした。24日目は、7danmoroboshiさんです。 みなさん、#テフライブ！ していますか？ ここ最近、「Markdown原稿からPandocしてLaTeX組版する」一連の処理で、書籍製作することが増えてきました。 例えば、某弊社で製作させていただきました事例をいくつかあげます。 Andriy Burkov［著］、清水美樹［訳］ 『機械学習 100＋ページ エッセンス』（インプレス） David Thomas・Andrew Hunt［著］、村上雅章［訳］ 『達人プログラマー 熟達に向けたあなたの旅（第2版）』（オーム社） 内田智史［監修］、株式会社システム計画研究所［編］ 『C言語によるプログラミング －基礎編－（第3版）』（オーム社） 田中祥平［著］
この記事はEWBアドベントカレンダー2019の17日目の記事ということになりました。 adventar.org 20191217 20時30追記：Textileの複雑な表を追記。Textile、はてな記法の参考ページを追加 20191217 21時追記： CAS-UB記法の表と参考ページ追加。シンプルなテーブルでそれぞれのコードから得られる表が大体同じになるようにした Caution 対象言語は大体wikipediaの軽量マークアップ言語のページから。 テーブルヘッダ = TH テーブルデータ = TD 必ずしも記法フル対応では載せていない。 それぞれ同じ出力を得るテーブルを書くのは思った以上に面倒そうなのでやっていない。はてなのWebエディタで書き始めるんじゃなかった。 シンプルなテーブル Markdown(PHP Extra) テーブル（セル）内改行は<br>で実現 | TH | TH
「Qiitaの今読んでおくべき記事１００選」を通して見直されるといいなと思っていること(ポエム) 本集計は、 LGTM が最近されたほど価値が高い と評価しています。 実際に集計後のランキングは、ある程度、今価値の高い記事が載せれたのではないかと思っています。 Qiitaの記事には 更新日時から1年以上/3年以上経過すると警告が表示されます が、 自身が LGTM した記事に、いつ LGTM をしたかは分かりません。 記事については、何度も役に立つ記事もあるし、 そのたびに投稿者には役に立ったことが伝わってもいいと思います。 再LGTMを促す仕組み や、 再LGTM の文化 があってもいいのではないか、と思っています ※ 再LGTMすることで、本ランキングは上がります。 さいごに 当初、ランキングは記事にするわけではなく自分の興味で作成しましたが、 結果として、 知らなかった良記事にも多く
マニュアルや操作説明書など、改版を繰り返す文書や、共同で執筆する文書などは、バージョン管理システムにより、最新版や改版履歴の管理が必要です。 Wordなどで作成されることが多いと思いますが、バージョン管理システムとの親和性やテキストデータの流用性、検索性に優れた軽量マークアップ言語の AsciiDoc を紹介します。 ここで紹介する AsciiDoc は、PDF形式の出力を前提に、Asciidoctor, Asciidoctor-pdf について説明します。 この文書も、AsciiDocで記述し、Git(バージョン管理システム)で修正履歴を管理しています。
ソフトウェアのテストしてますか？ では、ドキュメントは？ Jun Ohtani / Community Advocate at Elastic 2019/09/07 DevRel JP Conference about • • !2 Me, Jun Ohtani / Community Advocate ‒ lucene-gosenコミッター ‒ データ分析基盤構築入門 共著 ‒ http://blog.johtani.info Elastic, founded in 2012 ‒ Products: Elasticsearch, Logstash, Kibana, Beats Elastic APM, Elastic Cloud, Swiftype Professional services: Support & development subscriptions Trainings,
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
行政文書はMarkdownで管理できるか｜Hal Seki
JavaScript Promiseの本 v2リリース、ES2015+に対応、Async Functionの章を追加
gihyo.jp編集部におけるMarkdown記法 | gihyo.jp
JavaScript Primer 改訂2版をリリースしました！/JavaScript Primerはなぜ更新され続けるのか？
Maintainer Month: オープンソースをメンテナンスするコツ
オープンソースドキュメント翻訳プラットフォームとしての GitHub (React 日本語ドキュメントの例)
Please don't write your documentation in Markdown
【普段使いできる】psql メタコマンド10選【🐘🐘】 - AppBrew Tech Blog
MarkdownやAsciidoc中に書いたJavaScriptのサンプルコードをdoctestするツールを作った
シェーダー本を書いて得た知見まとめ - Qiita
［復刻］ドキュメント記述の心構え - ESM アジャイル事業部 開発者ブログ
GistPad - Visual Studio Marketplace
Please don't upload my code on GitHub
Elasticsearch 入門。その１ | DevelopersIO
手を動かせばできるLLVMバックエンド チュートリアル
DeepL Pro サイト翻訳で英語ドキュメントを快適に読む
エンジニアのドキュメント作成に適した「AsciiDoc」とは？
AsciiDoc で「イイ感じ」な文書を作る - ラック・セキュリティごった煮ブログ
ドキュメントは何で書けば良いのか - in neuro
Architectural Decision Records を知った
Markdown原稿からPandocしてLaTeX組版する本作りの事例 - Qiita
簡易マークアップテーブル記法まとめ - 自己顕示欲の開放治療所
「Qiitaの今読んでおくべき記事１００選」記事について - Qiita
AsciiDoc文書作成入門:: Asciidocによる文書作成環境の構築 [AFFRIT Portal]
ソフトウェアのテストしてますか？では、ドキュメントは？ by Jun Ohtani