Skip to content

kufu/product-design

Repository files navigation

Product Design Wiki

概要

Product Design Wiki へようこそ。SmartHR プロダクトデザイングループ内で獲得した知見、スキル定義、学習コンテンツを掲載しています。プロダクトデザインに関わる人はどなたでも利用・参加できます。

https://product-design.jp/

実行コマンド

yarn を推奨していますが、npm コマンドの利用も可能です。

Command Action
yarn install Installs dependencies
yarn dev Starts local dev server at localhost:3000
yarn build Build your production site to ./dist/
yarn preview Preview your build locally, before deploying
yarn astro ... Run CLI commands like astro add, astro check
yarn astro --help Get help using the Astro CLI

ディレクトリ構造

/
├── public/
├── src/
│   └── layouts/
│   └── pages/
│           └── columns/
│               └── *.md
│           └── words/
│               └── *.md
│           └── skills/
└── package.json

Product Design Wiki

[WIP]用語の追加方法

  • ドキュメント追加用ブランチを作成。
  • src/pages/{words, columns}配下に、_template.mdを参考に Markdown ファイルを作成。
  • ドキュメントを書く。
  • mainブランチへの Pull Request を作ってメンバーにレビューしてもらう。
  • レビュー完了後mainブランチへマージ。

独自Markdown記法

Product Design Wikiではドキュメントの利便性を高めるための記法を用意しています。

ページ内リンク

以下の記法で書いた場合、ドキュメント内のタイトルがサイト内のタイトルに一致する用語があれば、該当ページへ遷移します。

このリンクは:[タイトル]:へ遷移します。