How to indicate that verification/correction is requested in the document?

Question

I’ve been tasked to write a document (like a wiki) about an application for work. I don't know much about the app, other than what I'm understanding by reading the source code and minimal business requirements. As such, there are some assumptions I'm making in the document that I want verified/clarified by anyone reading it who knows more about that particular feature. Is there some kind of "grammatical feedback" *(kind of like when people use **(sp?)** to indicate that they are unsure of a word spelling)* that I could use to annotate a particular phrase or word? For instance: > This controller provides *[access to the following CRUD > operations ]* (unsure of bracketed text) Thanks.

Answer 1

I am tasked to write about, plan to implement and implement applications for a living for which I typically have no requirements for before hand. I adapt to the departments preferred scripting language, in this case PowerShell, using comments:

<#

Example comment

#>

<#Example comment_2#>

During code review sessions these comments are parsed by identifying the string "<#" variable and redacted to the correct notation. Making your specific team happy is what matters here and that they understand to parse for "<#".