GNOME Documentation Style Guide [was: New developer.gnome.org!]

This is an OpenPGP/MIME signed message (RFC 4880 and 3156)
--===============6297105624052369541==
Content-Type: multipart/signed; micalg=pgp-sha256;
 protocol="application/pgp-signature";
 boundary="qBWlH90toMNQOiNaZswiSWEhioyS7pV28"

This is an OpenPGP/MIME signed message (RFC 4880 and 3156)
--qBWlH90toMNQOiNaZswiSWEhioyS7pV28
Content-Type: multipart/mixed; boundary="prr3gZoGRfZi0WtQ8vjnwdDEjJe3HvrpD";
 protected-headers="v1"
From: sajolida <[email protected]>
To: [email protected]
Message-ID: <[email protected]>
Subject: GNOME Documentation Style Guide [was: New developer.gnome.org!]
References: <CALnHYQER+Vd8NgGg42hd5386hBCcuu2opW4K29AAv+zy6=jk3w@mail.gmail.com>
In-Reply-To: <CALnHYQER+Vd8NgGg42hd5386hBCcuu2opW4K29AAv+zy6=jk3w@mail.gmail.com>

--prr3gZoGRfZi0WtQ8vjnwdDEjJe3HvrpD
Content-Type: text/plain; charset=utf-8
Content-Language: en-US
Content-Transfer-Encoding: quoted-printable

Emmanuele Bassi via gnome-doc-list:
>=20
> I've just announced the new version of the developer.gnome.org
> <http://developer.gnome.org> website:

Hi, sajolida from Tails here.

Sorry I'm probably very late to the dance but I now see that the former
GNOME Documentation Style Guide disappeared from the new
developer.gnome.org:

https://developer.gnome.org/gdp-style-guide/

We used it as a reference for our documentation work at Tails:

https://tails.boum.org/contribute/how/documentation/guidelines/

Are there any plans to put it back online? Update it?

It wasn't updated to GNOME 3 but we still found the content relevant and
useful. It was a big source of inspiration for me when I started writing
documentation for Tails 10 years ago :)

I guess that it could also be useful as a terminology reference for
people developing GNOME apps. Good terminology and clear writing is such
an important part of UX design and GUIs as well!

I couldn't find the previous page on archive.org but I might still have
a copy somewhere in a backup, if that helps.

Nowadays, Write the Docs has good guidelines for good doc writing in
general:

https://www.writethedocs.org/guide/

Other good non-free guides and glossaries are also online now, like the
Microsoft and Google style guides:

https://developers.google.com/style
https://docs.microsoft.com/en-us/style-guide/welcome/

But I think it would still make sense, and improve the overall UX of
GNOME, to have writing resources specific to GNOME.

--=20
sajolida
Tails =E2=80=94 https://tails.boum.org/
UX =C2=B7 Fundraising =C2=B7 Technical Writing


--prr3gZoGRfZi0WtQ8vjnwdDEjJe3HvrpD--

--qBWlH90toMNQOiNaZswiSWEhioyS7pV28
Content-Type: application/pgp-signature; name="OpenPGP_signature.asc"
Content-Description: OpenPGP digital signature
Content-Disposition: attachment; filename="OpenPGP_signature"

-----BEGIN PGP SIGNATURE-----

wsF5BAABCAAjFiEE34QXUrVc2X/aSHmynlsE9DD4CiwFAmEVWYkFAwAAAAAACgkQnlsE9DD4CiwC
Rg//SQ2ZD5nQF8J4rXg6CQLfiUu809Ulrwi+C6+jEF8QNqP6GsfOgx6yDjKf/QsBCgJUYn8ERtU7
olydvLqpTazD+HVUoE/XOJxONS9dVAwOT3sm0+KiGiXk+qMR6em8kt7rQ4dzsNvYsyhYYPIpEhW8
NNQ0y39e4DVXHfj6aFmb6QLvuRDOk5qC3vIw2uLKR5AtDrxhCqn6Rhg5g+AcohkxsowEajcArUZr
aNVMM+bN5c7ahc9qXsR1Lw9FUxooTLtbd5+kwVpqFau9vn5wpijsFv311HhlHY0dNt0qeHlcPjh4
TD5OkhDRWxxWNX7BjearFymHdBsy85Ico2UzAfihSL8bHCj0Aos8TZIYYVQUQAeuJr5J4xlNSu0V
bkoXH7XEV+gL6RCBHGNK03I/C30bndkyey6MU2bmXnmzdyJtJFWGjEnKXOvRd91CjciV9eXSd4tY
UtgcOEPFDN7kS1OyYfFo94oVWd5w91oPZ+1QtjsIQh2UnbPElQ8gkAZTInY459QOPfV1UVYOPd1a
EBkEsI4siAjOkZ5tkRaIRc7JgiAKOKMaxaco8yAyvqPU8L3Qx42LnPkEhOYh7RYuss8eTQYi6Yoq
EMhbuDj0Bn4GKtrUg59FxbbV3hUFjNIQyp08CFU/ABJMvccJ3BapjXFZMpfbpVjY61v3p1MWJc26
/xQ=
=7Uxh
-----END PGP SIGNATURE-----

--qBWlH90toMNQOiNaZswiSWEhioyS7pV28--

--===============6297105624052369541==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline

_______________________________________________
gnome-doc-list mailing list
[email protected]
https://mail.gnome.org/mailman/listinfo/gnome-doc-list

--===============6297105624052369541==--