Introduction and questions

[diego.schiavon]

Hello Wiki gardeners,

My name is Diego Schiavon and I work as a technical writer for a company selling a Share mod I am supposed to document. I recently joined this group and have been lurking for a while.
Since I peruse the Alfresco wiki on a daily basis, I thought I could try to improve it to my and my readership's advantage.

Since I do not have a strong technical background, I thought I could help out with editing texts. To that purpose, I have a few questions:

- Does the wiki use a style guide? If it does not, is that by choice (for example to respect the contributor's style) or would you consider using one?
- Is there an established reviewing/editing process? Again, if there is not, is that by choice, or would you consider using one?
- Finally, do you have some lowly grunt work you may want to offload to me to help me familiarize with the wiki structure/organization/history?

Thank you and best regards,

Diego

[Jeff Potts]

Diego,

Welcome to the group and thanks for introducing yourself.

First, a few answers for you...

> - Does the wiki use a style guide? If it does not, is that by choice (for example to respect the contributor's style) or would you consider using one?

We don't have a style guide. We have some guidelines. They live here: https://wiki.alfresco.com/wiki/Wiki_Guidelines

I think style guide is probably too much for where we are right now with the wiki. I am concerned it would pose a roadblock for contributions.

> - Is there an established reviewing/editing process? Again, if there is not, is that by choice, or would you consider using one?

When the wiki was our only source of documentation, I suppose the docs team followed a reviewing/editing process. Now there is no process. I would be interested in what you might propose, but similar to the previous point, we need wiki editing to be as frictionless as possible.

> - Finally, do you have some lowly grunt work you may want to offload to me to help me familiarize with the wiki structure/organization/history?

There are pages in the wiki that are completely duplicated by pages in our official documentation site (http://docs.alfresco.com). I would like those replaced with a reference to the equivalent on the docs site.

Recently, there was a report that the CMIS pages are out-of-date. For example, I believe there are multiple mentions of the old CMIS end point URL which was deprecated in 4.0. (Old URL is /alfresco/s/api/cmis, New URL is /alfresco/cmisatom). So any CMIS page that is about Alfresco 4.0 and higher needs to be using the new URL.

Any page that is version specific needs to be in a version specific category. If there are pages that aren't tagged with a version they need to be. Also, I wonder if there is a better way to indicate the version a page relates to. Currently readers have to scroll to the bottom to see the categories to notice that.

Those are some ideas off the top of my head.

Thanks for any help you can give.

Jeff