-
Notifications
You must be signed in to change notification settings - Fork 17
docs: 日本語版についてのセクションを追加 #329
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
964e501
docs: 日本語版についてのセクションを追加
3w36zj6 d0a182b
Merge remote-tracking branch 'origin/main' into feature/add-about-pro…
3w36zj6 3b870c9
docs: 人力で翻訳する理由を追加
3w36zj6 dc3d130
docs: 公式ドキュメントへの案内を改善
3w36zj6 9372f1e
docs: 接続詞を修正
3w36zj6 20b9c87
docs: 貢献ガイドラインのシンボリックリンクを削除
3w36zj6 0b1ce14
docs: 人力で翻訳する理由のtextlintのエラーを修正
3w36zj6 0ad8417
docs: 貢献ガイドラインのtextlintのエラーを修正
3w36zj6 6af8720
docs: READMEの文章を改善
3w36zj6 dc19d38
docs: READMEにロゴを追加
3w36zj6 9496165
docs: READMEの謝辞をライセンスと管理者に変更
3w36zj6 9e256e8
docs: 人力で翻訳する理由の文章を改善
3w36zj6 ac96e17
docs: 貢献ガイドラインのリンクを修正
3w36zj6 a792055
docs: READMEのロゴに代替テキストを追加
3w36zj6 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3w36zj6 marked this conversation as resolved.
Show resolved
Hide resolved
|
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,39 +1,44 @@ | ||
| # Typst 日本語ドキュメント (非公式) | ||
| <div align="center"> | ||
| <img src="https://avatars.githubusercontent.com/u/172375917" width="128" height="128" alt="typst-jpのロゴ"> | ||
| <h1>Typstドキュメント日本語版</h1> | ||
|
|
||
| [](https://github.com/typst-jp/docs/actions/workflows/website.yml) | ||
| [](https://github.com/typst-jp/docs/actions/workflows/website.yml) | ||
| </div> | ||
|
|
||
| > [!NOTE] | ||
| > For English version, please refer to [README.en.md](README.en.md). | ||
| [Typst Documentation](https://typst.app/docs/)のコミュニティ主導による日本語版。 | ||
|
|
||
| 組版システム [Typst](https://typst.app/docs) の非公式な日本語ドキュメントです。[Typst GmbH](https://typst.app/legal/) の許諾を得て作成されています。 | ||
| A community-driven Japanese translation of the [Typst Documentation](https://typst.app/docs/). | ||
|
|
||
| このリポジトリは[中国語版](https://github.com/typst-doc-cn/typst-doc-cn.github.io)からフォークして作成され、2024年10月時点での最新版である [Typst v0.14.0](https://typst.app/docs/changelog/#v0.14.0) の公式ドキュメントを元に日本語訳を行います。 | ||
| 本サイトは<https://typst-jp.github.io/docs/>で公開しています。プロジェクトの詳細は、[日本語版について](https://typst-jp.github.io/docs/about/)をご覧ください。 | ||
|
|
||
| 実際に作動している Web 版は、以下の URL から閲覧できます。 | ||
| > https://typst-jp.github.io/docs/ | ||
| The documentation is available at <https://typst-jp.github.io/docs/>. For project details, please refer to [About the Japanese Edition](https://typst-jp.github.io/docs/about/). | ||
|
|
||
| ## 翻訳に参加するには | ||
| ## ライセンス / License | ||
|
|
||
| [貢献ガイドライン (CONTRIBUTING.md)](CONTRIBUTING.md) をご覧の上、[Pull Request](https://github.com/typst-jp/docs/pulls) を作成してください。[Issue](https://github.com/typst-jp/docs/issues)での質問や議論も歓迎します。 | ||
| <!-- textlint-disable prh --> | ||
|
|
||
| ご質問などがある場合は、[「くみはんクラブ」のDiscordサーバー](https://discord.gg/9xF7k4aAuH)に参加してご連絡ください。 | ||
| [typst/typst]: https://github.com/typst/typst | ||
|
|
||
| ## 翻訳参加者 | ||
3w36zj6 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| このプロジェクトは[typst/typst]からの派生プロジェクトであり、Apache-2.0 licenseでライセンスされています。 | ||
|
|
||
| <table cellspacing="0" cellpadding="0"> | ||
| <tbody> | ||
| <tr> | ||
| <td align="center"><a href="https://github.com/mkpoli"><img src="https://github.com/mkpoli.png" width="100px" alt="mkpoli"/><br /><sub><b>mkpoli</b></sub></a><br/><code>mkpoli</code><br/>言い出しっぺ<br/>保守者</td> | ||
| <td align="center"><a href="https://github.com/3w36zj6"><img src="https://github.com/3w36zj6.png" width="100px" alt="3w36zj6"/><br /><sub><b>3w36zj6</b></sub></a><br/><code>3w36zj6</code><br/>インフラ整備<br/>保守者</td> | ||
| <td align="center"><a href="https://github.com/stepney141"><img src="https://github.com/stepney141.png" width="100px" alt="stepney141"/><br /><sub><b>stepney141</b></sub></a><br/><code>stepney141</code><br/>インフラ整備<br/>保守者</td> | ||
| <td align="center"><a href="https://github.com/gomazarashi"><img src="https://github.com/gomazarashi.png" width="100px" alt="gomazarashi"/><br /><sub><b>gomazarashi</b></sub></a><br/><code>gomazarashi</code><br/>翻訳者<br/>保守者</td> | ||
| <td align="center"><a href="https://github.com/monaqa"><img src="https://github.com/monaqa.png" width="100px" alt="monaqa"/><br /><sub><b>monaqa</b></sub></a><br/><code>monaqa</code><br/>翻訳者<br/>保守者</td> | ||
| </tr> | ||
| <tr> | ||
| <td align="center"><a href="https://github.com/kimushun1101"><img src="https://github.com/kimushun1101.png" width="100px" alt="Shunsuke KIMURA"/><br /><sub><b>Shunsuke KIMURA</b></sub></a><br/><code>kimshun1101</code><br/>翻訳者<br/>保守者</td> | ||
| <td align="center"><a href="https://github.com/zr-tex8r"><img src="https://github.com/zr-tex8r.png" width="100px" alt="Takayuki YATO"/><br /><sub><b>Takayuki YATO</b></sub></a><br/><code>zr-tex8r</code><br/>アドバイザー</td> | ||
| <td align="center"><a href="https://github.com/m1sk9"><img src="https://github.com/m1sk9.png" width="100px" alt="Sho Sakuma"/><br /><sub><b>Sho Sakuma</b></sub></a><br/><code>m1sk9</code><br/>校正者</td> | ||
| <td align="center"><a href="https://github.com/ultimatile"><img src="https://github.com/ultimatile.png" width="100px" alt="ultimatile"/><br /><sub><b>ultimatile</b></sub></a><br/><code>ultimatile</code><br/>翻訳者<br/>保守者</td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| This project is derived from [typst/typst] and is licensed under the Apache-2.0 license. | ||
|
|
||
| <!-- textlint-enable --> | ||
|
|
||
| ## 管理者 / Maintainers | ||
|
|
||
| [CODEOWNERS]: https://github.com/typst-jp/docs/blob/main/.github/CODEOWNERS | ||
|
|
||
| 現在アクティブなレビュワーは[CODEOWNERS]ファイルを参照してください。 | ||
|
|
||
| Currently active reviewers are listed in [CODEOWNERS] file. | ||
|
|
||
| - [@mkpoli](https://github.com/mkpoli) | ||
| - [@3w36zj6](https://github.com/3w36zj6) | ||
| - [@stepney141](https://github.com/stepney141) | ||
| - [@gomazarashi](https://github.com/gomazarashi) | ||
| - [@monaqa](https://github.com/monaqa) | ||
| - [@kimushun1101](https://github.com/kimushun1101) | ||
| - [@zr-tex8r](https://github.com/zr-tex8r) | ||
| - [@m1sk9](https://github.com/m1sk9) | ||
| - [@ultimatile](https://github.com/ultimatile) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,7 @@ | ||
| --- | ||
| description: | | ||
| 翻訳ガイドライン | ||
| --- | ||
| # 翻訳ガイドライン | ||
|
|
||
| [JTF日本語標準スタイルガイド 第3.0版]: https://www.jtf.jp/pdf/jtf_style_guide.pdf | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| --- | ||
| description: Typstドキュメント日本語版について | ||
| --- | ||
|
|
||
| # 日本語版について | ||
|
|
||
| [Typst Japanese Community]: https://github.com/typst-jp/ | ||
| [Typstドキュメント日本語版]: https://typst-jp.github.io/docs/ | ||
| [くみはんクラブ]: https://discord.gg/9xF7k4aAuH | ||
| [Typst Documentation]: https://typst.app/docs/ | ||
|
|
||
| 「[Typstドキュメント日本語版]」は、組版全般の日本語での議論や情報交換のためのDiscordサーバー「[くみはんクラブ]」の有志によって構成された「[Typst Japanese Community]」が、[Typst GmbH](https://typst.app/legal/) の許諾を得た上でメンテナンスしている、Typstの公式ドキュメント「[Typst Documentation]」のコミュニティ主導の日本語版です。 | ||
3w36zj6 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| 本プロジェクトは現在進行中のため、未翻訳の箇所や誤訳が残っている場合があります。また、情報が古くなることもあるため、バージョン情報にはご注意ください。必要に応じて、各ページの「原文(英語)を開く」から[Typst Documentation]の最新情報とあわせてご参照ください。 | ||
|
|
||
| さらに、本Webサイトでは公式ドキュメントにはない、日本語の組版に特化した情報や独自コンテンツを提供しています。 | ||
|
|
||
| 本サイトの情報が、皆様のTypst利用の一助となれば幸いです。 | ||
|
|
||
| ## 貢献する | ||
|
|
||
| 本Webサイトはオープンソースで、どなたでもメンテナンスにご参加いただけます。翻訳の提案や誤字脱字の修正、Typstに関する日本語記事の追加など、さまざまな形での貢献を歓迎しています。詳しくは下記ガイドラインをご覧の上、[Pull Request](https://github.com/typst-jp/docs/pulls)の作成をお願いします。[Issue](https://github.com/typst-jp/docs/issues)でのご質問やご意見もお待ちしています。 | ||
|
|
||
| - [貢献ガイドライン]($about/contributing) | ||
| - [翻訳ガイドライン]($about/translating-guidelines) | ||
|
|
||
| ご不明な点があれば、[くみはんクラブ]のDiscordサーバーにてお気軽にご連絡ください。 | ||
|
|
||
| ## FAQ | ||
3w36zj6 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ### 機械翻訳や大規模言語モデル(LLM)の性能が上がっている中で、なぜ人力で翻訳するのですか? | ||
|
|
||
| 機械翻訳やLLMは近年大きく進歩しており、非常に自然な翻訳が可能になっています。しかし、Typstのような専門性の高い技術文書において、プロジェクト固有の用語の統一や、日本語特有の組版文化への深い理解に基づく微妙なニュアンスの調整には、人間の目による最終確認が不可欠だと考えています。 | ||
| 技術文書においては、わずかな誤訳や曖昧な表現がユーザーの大きな混乱につながる可能性があります。 | ||
| そのため本プロジェクトでは、AIを強力なツールとして最大限活用しつつも、最終的な品質管理と原文の意図の担保は、人間が責任を持って行っています。 | ||
|
|
||
| このようにして品質を担保することで、日本語を第一言語とするユーザーが直接正確な情報へアクセスできるようになり、Typstに触れる心理的なハードルが下がります。 | ||
| 結果として日本語ユーザーの増加が期待され、日本語特有の組版機能や利用事例の改善への寄与につながると考えています。 | ||
|
|
||
| また、この活動を通じて専門用語や表現を統一し、日本語でTypstの情報を共有できる「言葉の基盤」を築くことも重要な目的です。 | ||
| 質問や解説記事などの整合性を保ちやすくなるだけでなく、将来的にLLMがウェブ上の情報を参照して回答を生成する際、整備された質の高い日本語ドキュメントが存在すること自体が、LLMによるTypst関連の回答の質向上にも大きく貢献します。 | ||
|
|
||
3w36zj6 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ### Webサイトの生成ツールはOSSですか? | ||
|
|
||
| はい。Webサイトの生成ツールは[typst-community/typst-docs-web](https://github.com/typst-community/typst-docs-web)で配布されており、Apache-2.0 licenseで利用可能です。 | ||
|
|
||
| TypstのコンパイラとドキュメントはOSSですが、WebサイトはOSSではありません。そのため、コミュニティ主導でドキュメントのWebサイトの生成ツールを開発する必要がありました。OSSではないWebサイトのアセットを含まないため、Webサイトのデザインは独自のものとなっています。 | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.