Best Practices for Writing SAS Documentation?

#1
Hi all, I'm looking for a style guide to writing documentation for SAS software.

Looking at docs for, say, procedures, there seems to be a common method of writing about them. For example, in this PDF book on procedures for Base 9.2, http://support.sas.com/documentation/cdl/en/proc/61895/PDF/default/proc.pdf , all the procs seem to be explained in an (overview, syntax, concepts, results, examples) format. I can work this out by example, but if I do, I'll likely miss key things like spelling conventions. Ideally I'd like to see a best practices guide for writing this sort of documentation, if one exists.

My goal is to write a SAS equivalent to this article, which is a support of the best practices for R documentation: http://www.stats-et-al.com/2019/04/writing-r-documentation-simplified.html

Can anyone point me in the right direction, or advise me towards some key examples?
 

hlsmith

Not a robit
#2
Yeah, I haven't seen a best practices. I would say the best place for this question should probably be over on the SAS webpage on one of the SAS Community threads. There are many people who post on that forum with extensive SAS experience and SAS employees answer questions on it as well.

https://communities.sas.com/
 

noetsi

Fortran must die
#4
I don't think there is a best practice. Copying the form of SAS documentation probably is as good as it gets.

I am not a great fan of SAS documentation which I find to be confusing commonly.
 
#6
> Copying the form of SAS documentation...

So far, this is what I've found.

> ...Documentation is one of SAS's strong points.

Which is why I'm so surprised by this. It's not like they are going to accept user-generated content, but to have something available, even for internal training, would seem to be a smart move on their part; especially given the 100+ books they already publish.
 

noetsi

Fortran must die
#7
Someday we will agree on something dason. :p I find it rarely if every answers questions I need to run models and the theory it references is not connected in the documentation to the code.
 

hlsmith

Not a robit
#8
Well, I think SAS likely has a document for every procedure. My old complaint a long time ago would be accessibility of their documentation, but now it's all on the WWW and you can find great sources via there SAS user group. The Lex Jansen (sp?) archive is great.