Skip to content

slack qa team 2020 03 17

akabeko edited this page Apr 19, 2020 · 1 revision

2020-03-17

Time (UTC) Icon Name Message
08:44 shinyu ユーザーガイドは、とりあえず最低限の英語・日本語のものができたと思いますが、まだ改良の余地がだいぶあると思います。

目次(サイドバーのナビゲーション)から必要な情報にアクセスできることが大事だと思います。
現状は、レベル2見出しまでしか目次に表示されず、レベル3見出しにあるEPUBやWeb出版物(複数HTML)の指定方法、見開きの指定方法、追加スタイルシートの指定方法などが、目次に表示されません。旧ユーザーガイドではそれらが目次にありました。レベル3見出しまでが目次に出るようにするとよいと思います。

以下、ユーザーガイドの新旧・日英の目次の比較:

Old-en: https://vivliostyle.github.io/vivliostyle.js/docs/en/
- Viewer User’s Guide
- How to use
- Specifying HTML documents to be displayed in Vivliostyle Viewer
- To display EPUB
- To display Web publications
- To specify page spread view mode
- To specify additional style sheets
- How to Print/Save as PDF from Vivliostyle Viewer
- CSS features supported by Vivliostyle
- Other documentation

Old-ja: https://vivliostyle.github.io/vivliostyle.js/docs/ja/
- Vivliostyle Viewer ユーザーガイド
- 使い方
- Vivliostyle Viewer で表示するHTML文書の指定
- EPUBを表示するには
- Web出版物を表示するには
- 見開きページ表示を指定するには
- スタイルシートを指定するには
- Vivliostyle Viewer から印刷・PDF出力を行うには
- VivliostyleがサポートするCSSの機能
- その他のドキュメント

New-en: https://docs.vivliostyle.org/#/user-guide
- User Guide
- Introduction
- Vivliostyle Viewer
- Supported document types
- Load document to render
- Fine-grained config
- Save and Print as PDF
- Supported CSS features

New-ja: https://docs.vivliostyle.org/#/ja/user-guide
- ユーザーガイド
- Introduction
- Vivliostyle Viewer
- サポートされている文書の種類
- 表示するHTML文書の指定
- 詳細な設定
- PDFとして出力・印刷
- サポートされているCSSの機能


改良案あればどうぞよろしく!
08:53 ogwata
New-ja: https://docs.vivliostyle.org/#/ja/user-guide
にある「Introduction」だけが英語であるのが気になっています。
次行の「Vivliostyle Viewe」は固有名詞なのでラテン文字でかまいません。
しかし、日本語ページですから「Introduction」を英語にする必要性は低いように感じます。

1. はじめに
2. イントロダクション
上記のいずれかでしょうけれど、1が順当であるように思います。
08:53 Kiara Translation 🇬🇧: & gt; New-ja: https://docs.vivliostyle.org/#/ja/user-guide
I'm worried that only "Introduction" in English is in English.
"Vivliostyle Viewe" on the next line is a proper noun, so it can be in Latin characters.
However, since it is a Japanese page, it seems that the need for "Introduction" in English is low.

1.First of all
2. Introduction
Any of the above, but I think 1 is in order.
10:58 ogwata <!here> ただ今、「使ってみる」のリードを書いているのですが、そこでご相談です。

Vivliostyleそのものはプロジェクトの総称です。では、そこに含まれる、個々のVivliostyle Viewer, Vivliostyle CLI、Vivliostyle Pubは、なんと呼びましょう? 英語名も含めて考えないといけません。

• プロダクト
• プログラム
どちらもシックリきまぜん。
10:58 Kiara Translation 🇬🇧: <! here> Right now, I'm writing a lead on "Try it out", but we're here to talk.

Vivliostyle itself is a generic term for a project. So what are the individual Vivliostyle Viewers, Vivliostyle CLIs, and Vivliostyle Pubs included in them?考 え You have to think about English names.

• Product
• Program
Both are chicly mixed.
16:26 ogwata 「ドキュメント」のヘッダ構成についてご相談。
https://vivliostyle-org.yamasy1549.now.sh/ja/documents/

現状の構成は下記のようになっています。

(H1)ドキュメント
  (H2)ガイド
    (H3)ユーザーガイド
    (H3)コントリビューションガイド
  (H2)リファレンス
  (H2)今後の開発予定
    (H3)Vivliostyle Core
    (H3)Vivliostyle Pub
    (H3)Vivliostyle CLI
    (H3)Vivliostyle Viewer
    (H3)その他
  (H2)コミュニティへの招待

※なお、現状H1はありません(リードの原稿待ち)
※それから、上記「リファレンス」は H3 の間違いだと思います。

その上で相談なのですが、現在H1 の「ドキュメント」は、意味的に「ガイド」しか包含していません。

できれば、H1は「ガイド」「今後の開発予定」「コミュニティへの招待」の3つを包含するものが分かりやすいと思います。

いろいろ考えましたが、H1を「インフォメーション」に変更し、「ドキュメント」はH2に変更してはどうでしょう。以下のようになります。

(H1)インフォメーション
  (H2)ドキュメント
    (H3)ユーザーガイド
    (H3)コントリビューションガイド
    (H3)リファレンス
  (H2)今後の開発予定
    (H3)Vivliostyle Core
    (H3)Vivliostyle Pub
    (H3)Vivliostyle CLI
    (H3)Vivliostyle Viewer
    (H3)その他
  (H2)コミュニティへの招待

グローバル項目の変更にも関わるので、皆さんの意見を聞きたいと思います。

もう一つ、「コントリビューションガイド」「リファレンス」は誰に向けた情報か明確化するため、「開発ガイド」「開発情報」に変更するのはどうでしょう。

非開発者にとって重要な項目は「ユーザーガイド」です。しかし、現状の「コントリビューションガイド」「リファレンス」だと、これらも非開発者向けの情報と勘違いして、彼らに余計な時間を使わせそうです。

この結果、以下のようになります。

  (H2)ドキュメント
    (H3)ユーザーガイド
    (H3)開発ガイド
    (H3)開発情報

なお、英語サイトの方は、相対的に非開発者が少ないと思われるので、現状のままでよいと思うのですが、この点も意見を聞きたいところです。
Vivliostyle — open source, web browser based CSS typesetting engine project
16:49 ogwata 「インフォメーション」の9文字はグローバルメニューに収まりづらいかもしれません。
となると「情報」の方がよいでしょうか?
16:49 Kiara Translation 🇬🇧: The nine characters of "Information" may be difficult to fit in the global menu.
When it comes to information, is information better?
17:05 yamasy1549 「ドキュメント」という単語はプログラマにとって親しみやすいのでこの単語を使ったほうが良い、というお話だったと思います。
17:05 Kiara Translation 🇬🇧: I think the word "document" was a good idea for programmers, so it was better to use it.
Clone this wiki locally