[Owasp-testing] Updated Index draft

[Matteo Meucci]

Hi,
that's a good point.
It's important to write good quality articles also from an english
language point of view.
Last year we did a great job but the Guide still suffers of many
grammatical problems. That's why we need 2-3 reviewers that can
http://www.owasp.org/index.php/OWASP_Writing_Style

>1) I'd suggest we don't use "and/or" is looks indecisive/quick/messy.
>I've got an illustrative example here if you care to take a look:
>https://www.owasp.org/index.php/User:Rick.mitchell#.22and.2For.22_Explan
>ation

Yes

>2) We need to come up with a standard for section naming conventions
>(this isn't unique to your article). wikipedia suggests only leading
>caps however I think the overall plan here is to publish this as a *.doc
>and *.pdf once complete so I suggest full title caps.

Yes we have for example Testing_for_Directory_Traversal:
https://www.owasp.org/index.php/Testing_for_Directory_Traversal


3) I suggest we add some sort of tag to the index page
(https://www.owasp.org/index.php/OWASP_Testing_Guide_v3_Table_of_Content
s) similar to the "(new)" and "(toimp)" tags to indicate when sections
are ready to be reviewed. Perhaps (100), (toreview), or (reviewpls).

100% percent meaning that section is ready to be reviewed.

4) I agree we should attempt to write in the third person (as has been
discussed already).

I agree, I'm checking all articles and the reviewers will do that.

5) If we're going to use slang terms like "automagically" we should
agree on a formatting scheme (unerline, italics, quoted, or whatever).
I agree

Thanks,
Mat

On Mon, Jun 9, 2008 at 5:52 PM,  <rick.mitchell at bell.ca> wrote:
>
Hi Kevin & everyone,
>
> A few things come to mind, none of which are specific to Kevin's
> article.
>
> 1) I'd suggest we don't use "and/or" is looks indecisive/quick/messy.
> I've got an illustrative example here if you care to take a look:
> https://www.owasp.org/index.php/User:Rick.mitchell#.22and.2For.22_Explan
> ation
>
> 2) We need to come up with a standard for section naming conventions
> (this isn't unique to your article). wikipedia suggests only leading
> caps however I think the overall plan here is to publish this as a *.doc
> and *.pdf once complete so I suggest full title caps.

>
> 3) I suggest we add some sort of tag to the index page
> (https://www.owasp.org/index.php/OWASP_Testing_Guide_v3_Table_of_Content
> s) similar to the "(new)" and "(toimp)" tags to indicate when sections
> are ready to be reviewed. Perhaps (100), (toreview), or (reviewpls).
>
> 4) I agree we should attempt to write in the third person (as has been
> discussed already).
>
> 5) If we're going to use slang terms like "automagically" we should
> agree on a formatting scheme (unerline, italics, quoted, or whatever).
>
> Other than that the article is in good shape. I made some minor edits
> which you can see via the following diff:
> https://www.owasp.org/index.php?title=Testing%3A_Identify_application_en
> try_points&diff=30882&oldid=30711
>
> Rick
> _______________________________________________
> Owasp-testing mailing list
> Owasp-testing at lists.owasp.org
> https://lists.owasp.org/mailman/listinfo/owasp-testing
>