[B! 設計] Sireのブックマーク

Markdownでシーケンス図とかが書けるMermaid記法で業務フローを書いたら意外とイケたので自分なりのコツを紹介してみる | DevelopersIO

こんにちは、臼田です。みなさん、業務設計してますか？(挨拶今回はMarkdownでシーケンス図やフローチャートなどの図を記述できるMermaidを使って業務フローを書いてみたら、意外と書けたので自分なりのTipsを紹介したいと思います。その前に注意点として、まだMermaidを使い始めたばかりなので、﹁もっとこうしたらいいぞ﹂とか﹁こっちのほうがいいぞ﹂とかあれば建設的なフィードバックとしてSNSとかでいただけるとありがたいです。あと業務フローって表現しましたが、人によって思い描く業務フローが違うと思うので、業務フローの定義に関するツッコミはご容赦ください。私が今回Mermaidで書いたのは以下の図です。(内容はブログ用に簡素化しました) この図のコードは以下のとおりです。(後ほど解説します) sequenceDiagram autonumber actor お客様 partic

Sire 2022/05/01

設計

リンク

mkdocsのカスタマイズ - 笹山の自己成長ブログ

site_name: 笹山の自己成長ブログ site_url: https://n-sasayama.com/ site_dir: public markdown_extensions: - plantuml_markdown: server: http://www.plantuml.com/plantuml - pymdownx.tilde: - pymdownx.highlight: linenums: true - pymdownx.superfences theme: name: 'material' language: 'ja' features: - navigation.tabs plugins: - search - git-revision-date-localized extra: search: language: 'jp' disqus: xxxxxxxxxxxx

Sire 2021/10/31

打ち消し線など

設計

リンク

MKDocs – 拡張プラグイン集(1) | DevelopersIO

はじめにおひさしぶりです。しがないOLくにきちです。久々のブログ投稿になりました。最近はドキュメント整備を主な仕事にしてまして︵たまにリファクタリングやテスト︶新しくドキュメント環境作ってみたりドキュメント書いたりして過ごしてます。その中で、これまでドキュメント作成に使用していたGitBook CLI の開発が止まってしまったため、新しいドキュメント生成ツールを導入しよう！ということになりました。導入の条件は色々ありましたが、今回導入に至ったのは﹁MKDocs﹂です。簡単で、プラグインの豊富さやモダンな見ため、既存のドキュメントよりも見やすくなったのが決め手でした。 MkDocs の導入については、すでに弊社しんや (shinyaa31) による導入手順ブログ﹁プロジェクトドキュメント構築向け静的サイトジェネレータ﹃MkDocs﹄及び﹃Material for MkDocs﹄の

Sire 2021/10/31

設計

リンク

HTML内にMarkdown記法を混ぜて使うシンプルな方法

福井市の中学生からの質問 HTMLのテンプレートにMarkdownを埋め込もうと考えたのですが、いい方法はないのでしょうか。 GitHubでドキュメント書く時に使うMarkdown記法、HTMLの替わりにシンプルにマークアップできるので慣れるといろいろ使いたくなりますよね！作りました！ <script src="https://taisukef.github.io/marked_md/marked.min.js"></script> Markdownを埋め込むよ <script>md(` # h1 ## h2 ### h3 #### h4 ##### h5 ###### h6 `)</script> 先頭のscriptタグはページ内にひとつあればOKです。思う存分 Markdown を使って、サクサクウェブサイト作っちゃいましょう！ <link rel="stylesheet" href

Sire 2021/10/27

設計

リンク

MkDocs拡張機能 - 黒鳥のメモ

黒鳥のメモ VRモデリング関係プログラミングドキュメント作成その他 MkDocs拡張機能 MkDocsは拡張機能︵Extension︶を有効にすることによって、様々な機能を追加することができる。公式サポート拡張︵Officially Supported Extensions︶公式でサポートされている拡張機能。MkDocsに最初から含まれており、追加インストールしなくても使用することができる。公式拡張機能のリスト導入方法 mkdocs.yml内でmarkdown_extensions:に拡張機能の名前を追加する。例‥Attribute Listsの場合

Sire 2021/10/09

コードハイライトの拡張など

設計

リンク

mkdocsでTechサイトを作ろう

時系列などに関係なく、調べたことをまとめるためのmkdocs製のページが概ね自分の納得いくLvまで構築できたので参考になるかわかりませんが、記事をなくしてシンプルにしたリポジトリを用意しました。公開ページはこちらになります。こちらのリポジトリをベースにして、 mkdocs.ymlを自分用に書き換えて、markdownの記事を書けば私のカスタマイズした環境とほぼ同じmkdocsのページができあがります。お手軽手順詳細を書く前に、かんたんな記事更新の段取りなど。準備リポジトリをForkするか中身を自分のリポジトリ以下にコピー mkdocs.ymlのサイト情報などを書き換える GithubAction用の設定を追加 GithubのリポジトリのSettingsからSecretsを選ぶ。右上の、New Repository Secretを選んで GithubのMailとア

Sire 2021/10/08

設計

リンク

マークダウンで簡単にサイト作成 - Docusaurusの使い方 | ウェブ制作 | 雑多制作 - Web/動画/紙媒体などの制作所

はじめにマークダウンファイルからサイトを生成する静的サイトジェネレータのDocusaurusの基本的な使い方をご紹介します。 Docusaurusは、情報量の多いマニュアルサイトの作成する際に重宝するツールです。 Docusaurusとは概要 Docusaurus︵ドキュザラス︶は、Facebookが開発しているドキュメントサイト作成ツールで、Facebook社のオープンソースソフトウェアのプロジェクトのためのツールとして開発されました。そのため、現在もDocusaurusはオープンソースプロジェクトのサイトを構築、維持するためのツールとして開発されています。 Docusaurusは、v1とv2があります。 v2はまだβ版ですが、新たにDocusaurusを使う方はv2の利用が推奨されています。本記事でもv2の使い方を説明します。なお、既にv1を利用している方向けには移行ガイドも

Sire 2021/10/08

設計

リンク

ドキュメント作成ツールの決定版！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 ※ただし，まだまだアルファなので４，５については工事が進行中追記：2021 年 5 月 12 日に β 版がリリースされ，2022/02/23 現在では beta.15

Sire 2021/06/09

設計
React

リンク

GitHub Actionsを利用したMkDocsの自動デプロイ - roy-n-roy メモ

Home InfiniBand C＃ Docker Linux Raspberry Pi RouterOS Windows Mkdocs プライバシー・ポリシー GitHub Actionsを利用したMkDocsの自動デプロイ MkDocsでWebページを編集する際、下記の図のようなワークフローを採っています。今回は、GitHub Actionsを利用して、MkDocsでのGitHub Pagesへのページ公開を自動化しました。 Github Actionsを利用するには 2020年2月時点で、GitHubのユーザであれば、Github Actionsを利用でき、 Freeプランでは、2,000分/月の実行時間内であれば無料で利用できます。詳細については、Github Actionsのページ1やヘルプ2を参照するとよいでしょう。 Github Actionsを利用するには、対象のリポジ

Sire 2021/04/26

git
設計

リンク

MkDocsによるドキュメント作成

📌 はじめに mkdocs は静的サイトジェネレータです。コンテンツは基本的に markdown 形式で記述したソースファイルになります。またHTML形式のファイルを使うことも出来ます。この記事では Windows で個人的な最低限の作成環境をまとめました。 MkDocs 📌 mkdocs のインストール python をインストールします。今回は 3.9 で試しました。なお、私の環境は Windows+miniconda で構築しています。次に pip を使って mkdocs をインストールします。 pip install mkdocs 動作環境は次のとおりです。 python 3.9.5 mkdocs 1.4.2 mkdocs-material 8.5.11 mkdocs-material-extentions 1.1.1 pymdown-extensions 9.9 📌 プ

Sire 2021/04/25

★★★★★

設計

リンク

GitHub - atstp/wasabi: maintainable, intuitive directory-structure documentation

Sire 2021/04/25

ディレクトリ構造を表現　使えない？

設計

リンク

プロジェクトドキュメント構築向け静的サイトジェネレータ『MkDocs』及び『Material for MkDocs』の個人的導入＆設定まとめ | DevelopersIO

プロジェクトドキュメント構築向け静的サイトジェネレータ『MkDocs』及び『Material for MkDocs』の個人的導入＆設定まとめ直近携わっているプロダクトで「ユーザーガイド」的なドキュメントを作る機会があり、暫く前に幾つか見繕ってみた結果「MkDocs」というツールを選定して環境を作成＆整備して来ました。個人的にこのツールは使い勝手がとても良いと思っており、継続して使って来ていました。当エントリでは今後の備忘録としてMkDocsの基本的な導入・設定方法と、そのMkDocsで適用させたスタイル「Material for MkDocs」をここまで使ってきた中での個人的Tipsなどをまとめておきたいと思います。 MkDocs Material for MkDocs - Material for MkDocs 目次 MkDocsとは MkDocsのインストール基本操作各種設定・

Sire 2021/04/25

設計

リンク

チームで機能設計するためのPlantUML標準化 | フューチャー技術ブログ

はじめに現在所属しているプロジェクトではWebAPIやバッチ処理の設計の一環としてPlantUMLを利用しています。効率よく品質高くアウトプットを出すためには、プログラミング言語に対してコーディング規約があるように、UMLに対してもチームで設計するにあたり一定のルールを決める必要があります。そこでプロジェクト内のPlantUMLを使用するうえでのガイドラインやルールをまとめる機会があり、せっかくなのでそれを記事化します。記事のゴールシーケンス図設計におけるPlantUMLの標準化必要最低限のルールだけに絞ってチーム設計の生産性と品質を上げる記事の前提ルールの想定の利用シーン‥ チームで大量生産する業務機能の処理フローを表現するために使う場合を想定。また、この記事に記載されているルールはRDBを中心的に使用したAPI処理やバッチ処理等を念頭に置き決められたものです。ルールの想

Sire 2020/06/22

設計

リンク

Teehanlax.com

teehanlax.com expired on 09/09/2022 and is pending renewal or deletion.

Sire 2010/09/14

部品ごとにレイヤーが分かれているわけでもない

リンク

iPhone向けアプリケーション、Webサイトを開発する際に使えるテンプレート·Mockapp template MOONGIFT

Mockapp templateはKeynote、PowerPoint用のフリーウェア。iPhone用ネイティブアプリケーションを開発するという話をちらほら聞くようになってきた。まだまだ日本での販売台数は少ないが先行投資兼世界市場へのアピールを兼ねてチャレンジする企業、個人が多い。企業であればアプリケーションの説明を兼ねてモックアップが必要になることもあるだろう。 iPhoneアプリ作りの企画にその時に使えるのがMockapp templateだ。Mockapp templateはAppleのプレゼンテーションソフトウェアであるKeynoteやWindowsのPowerPoint向けに提供されるテンプレートで、iPhoneのモックアップを作成するのにぴったりな素材になっている。枠が提供されているので、Mockapp templateを使って作ればモックアップが手早くできる。さらに別なフ

Sire 2009/09/26

リンク

TechCrunch Japanese アーカイブ » 完璧なiPhoneアプリのモックアップを作ってみよう（アプリの中身までは手伝えないが）

Foursquare, the location-focused outfit that in 2020 merged with Factual, another location-focused outfit, is joining the parade of companies to make cuts to one of its biggest cost centers –…

Sire 2008/08/21

iPhoneの部品が入っているよう

リンク

FirefoxにGUIプロトタイピングの機能を追加するものすごい拡張「The Pencil Project」:phpspot開発日誌

FirefoxにGUIプロトタイピングの機能を追加するものすごい拡張「The Pencil Project」 2008年07月09日- Home - Pencil Project FirefoxにGUIプロトタイピングの機能を追加するものすごい拡張「The Pencil Project」。 Pencil Projectを使えば、予め用意されているGUI部品をキャンバスにドラッグ＆ドロップしてプロトタイプの画面イメージを作成することができます。ボタンなんかも、ダブルクリックでキャプションを変えることができたり、VisualBasic、VisualC++などのアプリを使って画面デザインをしているイメージに近い操作感が実現できています。アプリっぽい画面を作ってみましたが、超簡単です。 GUIのスタンドアロンアプリだけでなく、Webサイトにも使うことが出来ます。 HTMLを使って簡単に画面を作