You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/development/translation.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,7 +36,7 @@ It is important to distinguish a number of concepts:
36
36
37
37
See also [W3C Localization vs. Internationalization](https://www.w3.org/International/questions/qa-i18n)
38
38
39
-
In general, internationalisation is a task during the development of the Single Source of Truth (SSOT) for a standard. Translation can take place as part of the core development process, or by supporting community translations, and localisation is a part of implementation support in particular countries and contexts.
39
+
In general, internationalisation is a task during the development of the [Single Source of Truth (SSOT)](pattern-ssot) for a standard. Translation can take place as part of the core development process, or by supporting community translations, and localisation is a part of implementation support in particular countries and contexts.
Copy file name to clipboardExpand all lines: docs/patterns/documentation.md
+20-6Lines changed: 20 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,19 +35,33 @@ Consider a piece of documentation about how a field within the data standard wor
35
35
* This field will probably have a name and a description about how it is used.
36
36
* Someone will write that down somewhere.
37
37
* Someone else will share that with other people, via email, on a web page, in a pdf, in a presentation, as guidance in a data collection tool, etc
38
-
*Unless those people work directly from the same source (of truth) they may introduce small changes, errors, or even improvements as they reproduce the information.
38
+
*Those people may introduce small changes, errors, or even improvements as they reproduce the information.
39
39
* Further, the ‘master’ description may change over time. How do people know whether the new description, or the old one is the correct one to use? Which (trusted) source should they use? An email someone sent, or the PDF they have in their hand, or…?
40
40
41
+
In a worst case, people might incorrectly copy the structural information about the standard, e.g. a field name, or where it is nested; or, they might miss a field from a list that's intended to be complete.
42
+
43
+
### Solution
44
+
45
+
Establish a Single Source of Truth (SSOT) for documentation about how the standard works. Other copies should copy verbatim from this - any improvements should be made in the SSOT.
46
+
47
+
### Method
48
+
49
+
We use a [GitHub repository](pattern-version-control-changelog) to store our SSOT, as this provides very explicit and fine-grained versioning
50
+
51
+
In order to ensure documentation is pulled from the SSOT, copies should preferentially be made programmatically.
52
+
53
+
### Example
54
+
55
+
For 360Giving, the following are all generated programmatically from the [JSON Schema SSOT](https://github.com/ThreeSixtyGiving/standard/blob/master/schema/360-giving-schema.json):
*[GrantNav](http://grantnav.threesixtygiving.org/) and the [Data Quality Tool](https://dataquality.threesixtygiving.org/) look up human readable titles in the schema.
0 commit comments