技術文書の書き方
howto-tech-docs.md 技術文書の書き方 このメモは、私（@ymmt2005）が長年にわたってソフトウェアプロダクト開発に関わってきて 2022年現在こうしたほうが良いと考えているベストプラクティスです。 科学的な分析等に基づくわけではない経験則であるため、今後も随時見直すことがありますし、 ここに書いてあることが常に正しいわけでもあらゆるソフトウェア開発に適するわけでもありません。 しかしながら、実務経験が豊富で、モダンな技術スタックに明るいエンジニアの経験則は一定の 役に立つのではないかと考えて記します。 技術文書とは ここでは、ソフトウェア開発で技術者が書くべき文書ということにします。 ソフトウェアエンジニアにも役割がいろいろあり、アーキテクトと independent contributor では書く文書が違うということはあるでしょうけれど、ここではごっちゃにします。
Wiki.js + Heroku を使って、無料で高機能の情報共有 wiki を簡単に作る
背景: GitHub wiki への不満 私の所属する研究室では、メンバー全員が１つの GitHub Organization に所属しており、情報共有はその Organization 上のリポジトリの GitHub wiki で行われています。 研究室がコンピュータサイエンス系であることもあってメンバーは GitHub や Markdown に慣れており、普段 GitHub wiki を使っていて困ることはそんなになかったのですが、それでも時々不満が出ることがありました。 不満として多いのは、色々記事を書いているうちに全体構造がよくわからなくなってしまうという点にあると思います。GitHub wiki ではディレクトリ構造を持てないので、全ての情報がリンクを経由してアクセスされることになり、段々と整理がつかなくなってしまいます。 複数のリポジトリにそれぞれ wiki を書くこともできます
「Visual Studio Codeの教科書」を読んでVS Codeの設定をゼロから見直してみた - karaage. [からあげ]
追記：VS Codeの入門書をZennでリリースしました ブログで扱ったVS Code関連の記事をまとめて、無料の電子書籍としてZennというプラットフォームでリリースしました。よければ、こちらも参考にしてみてください。 Visual Studio Codeの教科書 Visual Studio Codeの教科書を購入しました。基本的な使い方から拡張機能の作り方まで、広く押さえられていました。 プログラマーのためのVisual Studio Codeの教科書 (Compass Booksシリーズ) 作者:川崎 庸市,平岡 一成,阿佐 志保発売日: 2020/04/30メディア: Kindle版 自分は拡張機能作りには興味なかったのですが、思わず手を伸ばしたくなりますね。拡張機能作りまで興味ある方にとってはかなり良い本ではないかと思います。 本を読むと、色々改めて発見があったのと、拡張機能一回
![「Visual Studio Codeの教科書」を読んでVS Codeの設定をゼロから見直してみた - karaage. [からあげ]](https://cdn-ak-scissors.b.st-hatena.com/image/square/b8cf77980ab900ed339768901e94cfe2584441d7/height=288;version=1;width=512/https%3A%2F%2Fcdn-ak.f.st-hatena.com%2Fimages%2Ffotolife%2Fk%2Fkaraage%2F20200707%2F20200707003818.png)
まだ Word で消耗してるの？ 大学のレポートを Markdown で書こう - Qiita
環境構築が Docker でスッと行えるようにした新版を公開しました まだまだ Word で消耗してるの？ 大学のレポートを Markdown で書こう （Docker 編） https://qiita.com/Kumassy/items/ffa752da5f7193c4929c みなさん、大学の実験レポートは何で書いていますか？ Word ですか？ 私も去年は Word で書いていたのですが、特に数式の入力や式番号を振るのに苦労した覚えがあります 今年は LaTeX で書いてやる！ と心に決めていたのですが、LaTeX のシンタックスはちょっと面倒くさい感じがしました... そこでみつけた Pandoc Pandoc について Pandoc は Haskell で書かれた文章変換ツールです。Markdown から LaTeX、PDF の変換もできますし、ほかにもたくさんのフォーマットに対
Big Sky :: Microsoft Word を Markdown に変換するコマンド「docx2md」を作った。
8月に Google Developers Expert となり、新米の様にオロオロとしています。過去の GDE ミーティングの議事録を見せて頂いているのですが Google Document に保存されており、Go だけでなく他のカテゴリの GDE に関する物も含めると全てに目を通すのはなかなか骨が折れます。技術者なので問題は技術で解決すべく、これらの資料を grep 検索できる様にしました。 Google Document はエクスポートすると Microsoft Word の形式となるので、Microsoft Word から Markdown に変換するプログラムを書けばテキスト検索もできるし、なんならそのまま GitHub に貼り付けてしまう事もできます。 GitHub - mattn/docx2md docx2md Convert Microsoft Word Document
RedmineのWiki記法をマークダウン記法に変換するツール - Qiita
概要 RedmineのWikiを他のマークダウン記法のサイトに移行しようとしたところ、適当なサービスがなかったので、自分で作ってみました。 サービスURL GitHub 以下、GitHubにソースは公開しているので、機能不足があればプルリクだしていただけれると助かります。 Register as a new user and use Qiita more conveniently You get articles that match your needsYou can efficiently read back useful informationWhat you can do with signing up
会議を爆速にする、Visual Studio Code 超便利スニペット集 - Qiita
以前の投稿でVisual Studio CodeとMarkdown Preview Enhanced環境を組み合わせの便利さを紹介しました。 議事メモを作成にマークダウンを使うと、議論が構造化されて表示されるので、非常にわかりやすくなりますね。みなさんもお使いかと思います。本稿では、そこに、更にVisual Studio Codeにマークダウン用のスニペットを登録しておくことを提案します。 出席者の議論をフォーカスさせる図や表がスムーズに呼び出せますので、効率的な会議を行うことができます。そんな爆速会議に便利なスニペットをいくつか紹介します。 以下ではVisual Studio CodeエディタとMarkdown Preview Enhancedプラグインが前提となっております。環境構築には以前の投稿をご参照ください。 1.会議を一気に立ち上げる：議事録スニペット まずは議事録のテンプレー
Visual Studio Code + Markdown Preview Enhancedはチームでデファクト化したいMarkdown環境だ！、と思う�(2017/10月時点) - Qiita
Visual Studio Code + Markdown Preview Enhancedはチームでデファクト化したいMarkdown環境だ！、と思う�(2017/10月時点)MarkdownエディタVSCodeVisualStudioCode 0.注意書き 筆者の本稿での意図はエディタ宗教論争を巻き起こすことではありません。「世の中では、これくらいのことが出来るようになってきている」とご参考にしてただくことが本稿の狙いです。それによって何かのお役に立てれば幸いだなと思っています。 皆さんは自分の使いやすい、皆さんの用途やプロジェクトの環境をにあったエディタを使用していただければとお断りしておきます。 1.Markdown環境について Markdwonは以前に書いたように今後の文書生産性を変えていく可能性のあるツールの一つです。Markdownのメリットは次の点だと思います。 1.1.M
Boostnoteの使い方 - Qiita
Markdownで手軽にメモができる和製OSSノートアプリBoostnoteの現在の仕様をまとめました。 Boostnote.io ※2017/8/5更新、v0.8.12の仕様に対応しました。 基本 ノートを作る 通常のノートを作ります。 ここでエンターを押せば新規Markdown Noteが作成され、編集できるようになります。 スニペットを作る スニペットを作ります。 ここでエンターを押せば新規Snippet Noteが作成され、編集できるようになります。 通常のノートとの違いは、 複数タブ作ることができる exportできない ことなどがあります。 ホットキー Boostnoteにフォーカスが当たっていない時でも Boostnoteのメインウインドウを出す Boostnoteのfinderウインドウを出す ホットキーがあります。 これらはMenu->Hotkeyから設定することができま
Markdownで書ける、よさげなWikiサーバーソフトまとめ - Qiita
※この記事は僕のブログ（最近始めました）のクローン記事です。 なんとなく、グループ内部用のWikiに最適なやつって無いのかなあと思ったのです。特にどのグループというわけじゃありませんが、ええ、なんとなく。 サーバー設置型のWikiソフトウェアというと国内で有名なのはPukiWikiでしょうか。設置も手軽で拡張性も高く、すでに慣れ親しんだWikiですが、最近では各方面がMarkdownを採用してそれに慣れ親しんでしまい、このブログもプラグインを入れてMarkdownで書いているぐらいなので、Markdownで書けるWikiを探していたのです。 必要要件はこんな感じ。 サーバー設置型 グループ内部向けのポータル的Wikiに適している Markdownで書ける 使い方が簡単 日本人に厳しくない デザインがナウい というわけで昨日から丸２日ぐらいぶっ通しで調べぬいた結果はっぴょー。どんどんぱふぱふ
phpのmarkdownライブラリparsedown-extraをインストール - イノベートな非日常
注意点として、markdown extraはプラグインとしてサポートされているので、 別途インストールが必要 といってもcomposerでインストールする場合parsedown-extraを入れると 自動で本体もインストールされるので気にする必要はないけど 公式ホームページのデモはextra対応していないので注意 etra用のデモは別に用意されている http://parsedown.org/extra/ Extra対応するとパースが遅くなるから標準対応してないっぽい。 インストール composer require erusev/parsedown-extra 使い方 <?php require_once __DIR__.'/../vendor/autoload.php'; $html = (new ParsedownExtra())->text($body); composerのオート
PHP用のMarkdownパーサーライブラリ比較 - Qiita
PHPでMarkdownをパースする 訳あってPHPでMarkdownファイルをパースする必要が出てきましたので、ライブラリを比較してみました。 結論から言うと、cebe/markdownが一番良さそうに感じました。 比較用にリポジトリを作りました。 https://github.com/naga3/markdown-comparison composer installしてからindex.phpを開くといろいろなモードでREADME.mdをパースします。 比較ライブラリ PHP Markdown / cebe/markdown / Parsedown この3つがよく使われているようです。 Benckmark https://github.com/kzykhys/Markbench Parsedown > cebe/markdown > PHP Markdown 的な感じです。 PHP M
株式会社Qript グループ統合に関するお知らせ
このたび弊社を含む Penseur（パンスール）グループ傘下の事業再編にともない、2022年4月1日をもって、株式会社Qriptは株式会社Penseurへ吸収合併され、新たな歩みを進めることとなりました。 2000年に創業し本日に至るまで、多くの皆様からのご愛顧に対し、社員一同、深く感謝するとともに心より御礼申しあげます。 なお、弊社の既存事業・業務はすべて株式会社 Penseurにて継続してまいります。 事業再編により、新たな体制をもって総力を結集することが可能となり、今後さらに高付加価値のサービス提供が可能になると考えています。 今後も皆様のご期待に添えますよう全力を尽くしてまいりますので、引き続き、何卒ご指導ご鞭撻を賜りますようお願い申し上げます。 2022年4月1日 株式会社Qript 代表取締役 寺嶋正浩 株式会社Qript グループ統合に関するお知らせ（PDF） ※株式会社Qr
vim-quickrunとMarkedでmarkdown編集が快適になった - Glide Note
Marked - smart tools for smart writers 最近購入したMac用のMarkedというMarkdownのプレビューアプリの出来がかなり良い。 Markedの良い点 markdownのプレビュー機能に特化している。(markdownファイルをDrag&Dropでプレビュー） エディタ同梱のアプリではないので、自分の好きなエディタが使える GitHub風の表示スタイルがあって見やすい。(GitHub Flavored Markdownに完全対応しているわけではないですが) あまりに便利なので、vim-quickrunのmarkdownプレビュー用に使えるように設定。 vim-quickrunのバージョンは2013年1月11日時点で最新のVersion: 0.6.0を利用しています。 コマンドラインからMarkedを起動する場合は下記のような感じなので
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
vuetify-markdown-editor
Crowi
GitHub - thephpleague/html-to-markdown: Convert HTML to Markdown with PHP
http://geechs-magazine.com/tag/lifehack/20160113