PinotWalkで記事を作成・管理する方法を説明します。
Markdown記法 {#markdown-basics}
- PinotWalkの記事はMarkdown形式で書きます。
- Markdownを使うと、シンプルな記法で見やすい文書が作成できます。
- 詳しいMarkdown のチュートリアルはこちらです。
- でも、自分で覚えるのが大変なら・・・ご心配無用、あなたのセクレタリが全部やってくれます!
Mermaid図表 {#mermaid-diagrams}
- Mermaid記法を使うと、テキストから図表を自動生成できます。
graph TD
A[開始] --> B[処理]
B --> C[終了]
- フローチャート、シーケンス図、ガントチャートなど、さまざまな図が作成可能です。
- 詳しいMermaid記法については、以下のチュートリアルをご覧ください。
- Mermaid記法のチュートリアル
- Mermaid公式ドキュメント
- でも、自分で覚えるのが大変なら・・・ご心配無用、あなたのセクレタリが全部やってくれます!あなたはただ「こういう図をmermaidで描いて」と言えばいいだけです。
Space・記事の管理 {#spaces-and-articles}
概念の整理
PinotWalkのコンテンツは、以下の階層で管理されます。
組織(Organization: 会社など課金が発生する単位)
└── チーム(Team: 部署など同じ業務機能で集まる人々の単位)
└── Space(スペース:具体的な仕事・プロジェクトの単位)
└── 記事(Article)
| 概念 | 説明 | 例 |
|---|---|---|
| 組織 | 会社や団体 | 株式会社〇〇 |
| チーム | 組織内のグループ | 開発チーム、マーケチーム |
| Space | 記事をまとめるフォルダ | プロジェクトA、議事録 |
| 記事 | 個々のドキュメント | 設計書、レポート |
Spaceの操作
Spaceを作成する
- 右上の人型のハンバーガメニュからMy Pageをクリック
- 「Space」を選択
- Space名を入力
- 所属するチームを選択
- 「作成」をクリック
Spaceの設定
| 設定項目 | 説明 |
|---|---|
| Space名 | 表示される名前 |
| 説明 | Spaceの概要 |
| 公開設定 | 公開/チーム内限定/非公開 |
| アイコン | Space一覧で表示されるアイコン |
Spaceを整理する
- サブSpace: Space内にさらにSpaceを作成できます
- 移動: 記事を別のSpaceに移動できます
- アーカイブ: 使わなくなったSpaceをアーカイブできます
記事の操作
記事を作成する
- Space内で「新規作成」をクリック
- または、サイドバーの「新規作成」→「記事」
- タイトルを入力
- 本文をMarkdownで記述
- 「保存」をクリック
記事の編集
- 記事を開く
- 「編集」ボタンをクリック
- 内容を編集
- 「保存」をクリック
自動保存
編集中は一定間隔で自動保存されます。
ブラウザを閉じても、下書きが失われることはありません。
バージョン履歴
記事の変更履歴を確認できます。
- 記事を開く
- 「︙」メニュー → 「履歴」
- 過去のバージョンを確認・復元
検索
全文検索
ヘッダーの検索ボックスから、記事の内容を検索できます。
- タイトル
- 本文
- 作成者
フィルター
検索結果を絞り込めます。
- Space
- チーム
- 作成日
- 更新日
記事のURL
各記事には固有のURLが割り当てられます。
https://pinotwalk.com/orgs/{組織}/teams/{チーム}/spaces/{space}/blog/{記事ID}
このURLを共有すると、記事に直接アクセスできます。
(公開設定によってはログインが必要です)
インポート・エクスポート
エクスポート
記事をMarkdownファイルとしてダウンロードできます。
- 記事を開く
- 「︙」メニュー → 「エクスポート」
- 形式を選択(Markdown / PDF)
インポート
Markdownファイルを記事としてインポートできます。
- Space内で「インポート」をクリック
- ファイルを選択
- タイトルを確認
- 「インポート」をクリック
Tips
命名規則を決める
チームで使う場合は、Space名や記事タイトルの命名規則を決めておくと整理しやすくなります。
例:
[プロジェクト名] 設計書YYYYMMDD_議事録_会議名
テンプレートを活用
よく使う形式の記事は、テンプレートとして保存しておくと便利です。
公開・共有設定 {#publishing}
公開範囲の種類
記事とSpaceには、それぞれ公開範囲を設定できます。
| 設定 | 説明 | 閲覧できる人 |
|---|---|---|
| 公開 | インターネット上に公開 | 誰でも |
| チーム内 | 同じチームのメンバーのみ | チームメンバー |
| 非公開 | 自分のみ | 作成者のみ |
記事の公開設定
設定方法
- 記事を開く
- 「︙」メニュー → 「設定」
- 「公開範囲」を選択
- 「保存」をクリック
公開前のチェックリスト
公開する前に以下を確認しましょう。
- [ ] 機密情報が含まれていないか
- [ ] 誤字脱字がないか
- [ ] リンクが正しく機能するか
- [ ] 画像が表示されるか
Spaceの公開設定
Spaceの公開設定は、そのSpace内の記事にも影響します。
| Spaceの設定 | 記事への影響 |
|---|---|
| 公開 | 記事ごとに設定可能 |
| チーム内 | 記事はチーム内以下のみ設定可能 |
| 非公開 | 記事は非公開のみ |
共有方法
URLで共有
記事のURLをコピーして共有できます。
- 記事を開く
- アドレスバーのURLをコピー
- メールやチャットで送信
公開記事であれば、URLを知っている人は誰でもアクセスできます。
SNSでシェア
公開記事は、SNSでシェアできます。
- 記事を開く
- 「シェア」ボタンをクリック
- シェアしたいSNSを選択
対応SNS: Twitter/X、Facebook、LinkedIn など
埋め込み
公開記事を他のサイトに埋め込むことができます。
- 記事を開く
- 「︙」メニュー → 「埋め込みコード」
- コードをコピー
- 埋め込み先のHTMLに貼り付け
アクセス解析
公開記事には、簡易的なアクセス解析機能があります。
確認できる情報:
- 閲覧数(PV)
- ユニークユーザー数
- 参照元
確認方法
- 記事を開く
- 「︙」メニュー → 「アクセス解析」
注意事項
公開後の編集
公開後も記事は編集できます。
ただし、編集内容は即座に反映されるため注意してください。
削除について
公開記事を削除すると、そのURLは無効になります。
外部からリンクされている場合は、代わりの案内ページを用意することをおすすめします。
著作権
公開する内容の著作権に注意してください。
他者の著作物を引用する場合は、適切な出典を記載してください。
Comments