I remember from my long-gone days as a developer that great code documentation is vital for long-term projects. Cue a couple of head-scratching moments when re-opening earlier Coda docs… So I started writing comments in the doc itself, e.g.
=if([toggle implementation notes],"A helpful comment on what's going on"," ")
with a toggle in a Setting page to turn them on/off. They stay (almost) invisible for normal users.
But I’m sure others came with better ways! Do you have any best practice for doc design documentation?
I used a hidden page inside document to “explain” all the relations, formulas, workflows etc, but there are for sure more efficient ways to do it
Also formula comments would be such a nice addition, with the complexity you can achieve in Coda I start to think they are must
That is clever! My dream for table documentation is a text box built right into the column options dropdown. Currently, I do a “Source Tables” section with a table per page, and include a description and a bulleted list right in the canvas about the table, but it’s a pain and there’s no way for it to be in context of any views.
a dropdown [>>] with a “” / “info” / “readme”, to say people should read here for documentation/explanations. It would be nice if it could be default open or some kind of callout, especially for first time coda users, who see the doc as an app, and who don’t even know the concept of a dropdown that they can expand/collapse
a gslides, w/ screenshots and explainers, embedded in the first page of the doc
a page where I take team mates through a process step by step, explaning them each and every table cell they need to fill, with like 10 views that have 1 column and 1 line each, so I guide them very very very closely. but a “little” long setup ^^