This site uses different types of cookies, including analytics and functional cookies (its own and from other sites). To change your cookie settings or find out more, click here. If you continue browsing our website, you accept these cookies.
As I'm getting deeper into the SDK - I'm bumping into areas where the developer documentation needs uplift - e.g broken links, missing references, areas where clarification would be helpful.
What is the best way to communicate these to the right technical writer? I dont want to log support tickets and make @PaulN 'a life miserable. I could log them as ideas but that seems to be overkill. I could post them here and cc the correct technical writer?
c) Hyperlink the types to definition: if you look at this page (https://help.alteryx.com/20193/developer-help/outputanchor) and scroll down to the method definitions (init((RecordInfo)record_info_out, (str)sort_info_xml='') -> bool - could you just hyperlink directly to the documentation for RecordInfo class on these kind of definitions?
This seems like a really easy way to make it quicker for folk to get familiar with the SDK.
There are quite a few of these kind of smaller things; and there's also some larger pieces of effort (e.g. most API / SDK documentation I've used before has deep and rich example code - so the lack of this stands out) - so if there's someone tasked as a technical writer on the Help documents, I'm more than happy to do the detailed work with them.
Before I send these to helpfeedbadck e-mail like @PaulN mentioned - let me know if that's the best channel for these kind of things?