metanorma / metanorma-plateau

Metanorma for Project PLATEAU by MLIT
Other
2 stars 0 forks source link

Structure of a PLATEAU document #25

Closed ronaldtse closed 4 months ago

ronaldtse commented 5 months ago

In the following order.

Document 001

Introduction (はじめに) [unnumbered]

Screenshot 2024-05-25 at 9 57 49 AM

Summary of changes (改定の概要) [unnumbered]

Screenshot 2024-05-25 at 9 58 32 AM

TOC

Screenshot 2024-05-25 at 9 59 58 AM

1 Overview 概覧

1.1 "Product Specification Authorship Information 製品仕様の作成情報"

Screenshot 2024-05-25 at 10 05 24 AM

1.2. "Purpose 目的" (generic text)

Screenshot 2024-05-25 at 10 05 37 AM

1.3 "Product Scope 製品の範囲" (generic text)

Screenshot 2024-05-25 at 10 05 55 AM

1.4 "References" 引用規格等

Table 1 References that are standards

Screenshot 2024-05-25 at 10 06 18 AM

Table 2 References that are specifications

Screenshot 2024-05-25 at 10 28 35 AM

1.5 Terms and definitions 用語と定義

"標準製品仕様書で使用する用語を示す。以下に記載のない用語とその定義については、JPGIS 2014 付属書 5(規定)定義に従う。" => "The following terms are used in the standard product specifications. Terms and definitions not listed below are defined in JPGIS 2014, Appendix 5 (normative)."

Screenshot 2024-05-25 at 10 28 56 AM

1.6 Abbreviations 略語

Screenshot 2024-05-25 at 10 31 04 AM

A table describing a mapping of an abbreviation to version used.

Screenshot 2024-05-25 at 10 31 13 AM

Scope (適用範囲) [Clause 2]

Screenshot 2024-05-25 at 10 31 44 AM

Body content

Clause 3 and onwards.

Clause hierarchy:

Screenshot 2024-05-25 at 11 13 24 AM Screenshot 2024-05-25 at 11 13 36 AM Screenshot 2024-05-25 at 11 13 42 AM Screenshot 2024-05-25 at 11 14 12 AM

PDF TOC:

Screenshot 2024-05-25 at 11 13 12 AM

Clause hierarchy:

Screenshot 2024-05-25 at 11 10 52 AM

PDF TOC:

Screenshot 2024-05-25 at 11 12 17 AM

"Footnote"

Screenshot 2024-05-25 at 11 15 17 AM Screenshot 2024-05-25 at 11 15 52 AM

"Table Key"

Screenshot 2024-05-25 at 11 17 32 AM

"Table Source"

Screenshot 2024-05-25 at 11 17 06 AM

Bibliography [unnumbered]

Screenshot 2024-05-25 at 10 33 09 AM

Change history [unnumbered]

日付 => Date 版 => Edition 説明 => Description

Screenshot 2024-05-25 at 10 33 39 AM

Back cover [unnumbered]

Screenshot 2024-05-25 at 10 34 19 AM
ronaldtse commented 5 months ago

Document 002

Foreword

Summary of changes

TOC

Different from 001:

Screenshot 2024-05-25 at 10 42 50 AM Screenshot 2024-05-25 at 10 43 40 AM

0 Overview 概覧

Different from 001:

0.1 本書の目的

"本書の目的" (Purpose of this book) instead of just "目的" (Purpose) in 001. So this is free text?

0.2 引用文献

Different in title name of first table (standards references):

Screenshot 2024-05-25 at 10 46 34 AM

No second table (specification references).

Instead of a table in Abbreviated terms referring to versions, this information is provided in the References clause.

Screenshot 2024-05-25 at 10 47 12 AM

Main body elements

Screenshot 2024-05-25 at 10 48 17 AM

0.4 本書で使用する用語 (Terms and definitions)

Screenshot 2024-05-25 at 10 49 12 AM

But there is additional explanatory text after:

Screenshot 2024-05-25 at 10 49 36 AM

Main text from Clause 1 onwards

These additional elements:

"Item of attention"

Screenshot 2024-05-25 at 10 54 34 AM

"Explanation"

Screenshot 2024-05-25 at 10 54 57 AM

"Example" <img width="528" alt="Screenshot 2024-05-25 at 10 58 48 AM" src="https://github.com/metanorma/metanorma-plateau/assets/11865/64115eb3-b166-4

Screenshot 2024-05-25 at 10 58 56 AM

0b8-9a79-fbdbd5e47266">

"Requirement"

Screenshot 2024-05-25 at 10 59 26 AM Screenshot 2024-05-25 at 11 00 21 AM

"Recommendation"

Screenshot 2024-05-25 at 11 00 01 AM Screenshot 2024-05-25 at 11 00 06 AM

Clause hierarchy:

Screenshot 2024-05-25 at 11 07 32 AM

This subdivision of the clause is also in the TOC.

Screenshot 2024-05-25 at 11 07 42 AM

Bulleted items hierarchy:

Screenshot 2024-05-25 at 10 55 38 AM Screenshot 2024-05-25 at 10 56 17 AM Screenshot 2024-05-25 at 10 56 03 AM

Numbered list hierarchy:

Screenshot 2024-05-25 at 11 06 03 AM

Bibliography

Screenshot 2024-05-25 at 11 06 45 AM

Change history

Screenshot 2024-05-25 at 11 06 58 AM

Backcover

Screenshot 2024-05-25 at 11 07 05 AM
ReesePlews commented 5 months ago

@ronaldtse i will confirm if levels 4 and 5 should follow the current format or if it is possible to apply them to a JIS format. the current format is commonly used for japanese documents, yet there are disadvantages using these formats with machine processing and translation tools.

ReesePlews commented 5 months ago

@ronaldtse comments have been added to the off-github working document.

ronaldtse commented 4 months ago

Closing this since the document is nearly done.