Sachverhalt:
A. A.a Mit Klage vom 18. Mai 2004 verlangte X._ (im Folgenden: Beschwerdeführer) u.a. beim Bezirksgericht Zürich, es sei der Beschluss der Stockwerkeigentümer-Gemeinschaft W._strasse 001 betreffend Genehmigung der Jahresrechnung 2003 und Entlastung der Verwaltung aufzuheben. Mit Beschluss vom 23. August 2005 schrieb das Bezirksgericht die Klagebegehren 2-5 der Hauptklage als durch Rückzug erledigt ab. Mit Urteil desselben Tages wies das Bezirksgericht das Hauptklagebegehren 1 (Jahresrechnung 2003 und Entlastung der Verwaltung) ab und hiess die Widerklagebegehren betreffend Geldforderungen im Umfang von Fr. 555.85 und Fr. 225.40 nebst Zins teilweise gut. Dagegen erhob der Beschwerdeführer Berufung beim Obergericht. Mit Beschluss vom 9. März 2006 trat das Obergericht auf die Berufung nicht ein, soweit sich diese gegen den Beschluss des Bezirksgerichts richtete und erklärte den Beschluss für rechtskräftig. Mit Urteil desselben Tages wies das Obergericht das Klagebegehren 1 ab und hiess die Widerklagebegehren betreffend die Geldforderungen erneut gut.
A.b Die vom Beschwerdeführer dagegen eingereichte Nichtigkeitsbeschwerde wurde vom Kassationsgericht des Kantons Zürich mit Beschluss vom 21. Dezember 2006 abgewiesen, soweit es darauf eintrat. Das Bundesgericht trat mit Urteil vom 28. März 2007 auf die vom Beschwerdeführer dagegen erhobene staatsrechtliche Beschwerde nicht ein (5P.52/2007).
A.c Das Kassationsgericht wies mit Beschluss vom 24. Juli 2007 ein Revisionsbegehren des Beschwerdeführers gegen den Beschluss vom 21. Dezember 2006 ab.
Der Beschwerdeführer reichte beim Kassationsgericht am 11. Januar 2008 ein weiteres Revisionsbegehren gegen den Beschluss vom 21. Dezember 2006 ein, worauf mit Beschluss vom 11. März 2008 nicht eingetreten wurde.
B. Mit Eingabe vom 28. April 2008 hat der Beschwerdeführer die Sache an das Bundesgericht weitergezogen und beantragt, den Zirkulationsbeschluss vom 11. März 2008 aufzuheben. Sodann ersucht er um Gewährung der unentgeltlichen Rechtspflege.
Vernehmlassungen wurden nicht eingeholt.
Erwägungen:
1. 1.1 Nicht entgegengenommen werden können von vornherein die Unterlagen, die der Beschwerdeführer dem Bundesgericht am 23. Mai 2008, also nach Ablauf der 30-tägigen Beschwerdefrist nach Art. 100 Abs. 1 BGG eingereicht hat. Das Gleiche gilt auch für die am 14. Juli 2008 bei Bundesgericht eingegangene Kopie einer Feststellungsklage gegen den Beschluss des Kassationsgerichts vom 11. März 2008.
1.2 Angefochten ist ein kantonal letztinstanzlicher Entscheid in Zivilsachen, welcher einen Endentscheid darstellt (Art. 72 Abs. 1, Art. 75 Abs. 1 und Art. 90 BGG). Beim Streit um die Gültigkeit von Beschlüssen der Versammlung der Stockwerkeigentümer mit finanziellen Auswirkungen handelt es sich um eine vermögensrechtliche Streitigkeit (BGE 108 II 77 E. 1b S. 79/80; 113 II 15 E. 1 S. 17; 131 III 459 nicht publizierte E. 1.1), welche der Beschwerde in Zivilsachen unterliegt, wenn der Streitwert wenigstens Fr. 30'000.-- beträgt (Art. 74 Abs. 1 lit. b BGG). Dies gilt auch für entsprechende Revisionsverfahren. Gemäss dem angefochtenen Beschluss beträgt der Streitwert Fr. 22'000.-- (S. 7 III.). Sinngemäss behauptet der Beschwerdeführer, der Streitwert der Jahresrechnung 2003 liege höher, begründet dies aber nicht. Es ist deshalb auf den von der Vorinstanz angeführten Streitwert abzustellen.
1.3 Der Beschwerdeführer ist der Meinung, es stelle sich eine Rechtsfrage von grundsätzlicher Bedeutung nach Art. 74 Abs. 2 lit. a BGG (dazu: BGE 134 III 267 E. 1.2 mit Hinweisen). Er erblickt eine Frage von grundsätzlicher Bedeutung darin, ob der Beschluss, mit dem die Stockwerkeigentümer-Gemeinschaft den Verwalter ermächtigt, zur Führung eines Zivilprozesses einen Rechtsanwalt zu beauftragen, mit einfachem Mehr gefasst werden kann oder ob es hierfür eines einstimmigen Beschlusses bedarf. Im Entscheid des Kassationsgerichts vom 21. Dezember 2006 wurde diese Frage eingehend behandelt und die Einstimmigkeit wurde verneint. Diesen Beschluss hat der Beschwerdeführer mit staatsrechtlicher Beschwerde beim Bundesgericht angefochten, welches mit Urteil vom 28. März 2007 auf das Rechtsmittel nicht eintrat, weil der Kostenvorschuss nicht geleistet worden war. Der Inhalt dieser rechtskräftigen Entscheide und die sich dort stellenden Rechtsfragen stehen im vorliegenden Revisionsverfahren vorerst nicht zur Beurteilung. Erst wenn die Vorinstanz einen Revisionsgrund anerkennen und ihren rechtskräftigen Entscheid vom 21. Dezember 2006 aufheben würde, müsste sich das Gericht erneut mit den seinerzeit aufgeworfenen Fragen befassen und es wäre zu prüfen, ob sich dort Fragen von grundsätzlicher Bedeutung stellen.
Anfechtungsobjekt bildet nur der Beschluss des Kassationsgerichts vom 11. März 2008, in dem das Gericht ausschliesslich geprüft hat, ob der Beschwerdeführer einen Revisionsgrund nach kantonalem Recht hat nachweisen können oder nicht, und es hat diese Frage verneint. Dabei hat das Gericht einzig die Rechtzeitigkeit der tatsächlichen Vorbringen zur Wahl des Rechtsvertreters der Stockwerkeigentümer-Gemeinschaft und zur Frage geprüft, ob die Stockwerkeigentümer-Gemeinschaft über die Nebenkostenabrechnung mit einem Mehrheitsbeschluss habe entscheiden können. Der Beschwerdeführer wirft in diesem Zusammenhang keine Fragen von grundsätzlicher Bedeutung auf. Zum einen beschlägt die Revision kantonales Verfahrensrecht, welches gemäss Art. 95 BGG keinen zulässigen Rügegrund abgibt und in dem sich aus bundesrechtlicher Sicht kaum Fragen von grundsätzlicher Bedeutung stellen. Zum andern bezweckt Art. 74 Abs. 2 lit. a BGG eine einheitliche Anwendung von Bundesrecht und des internationalen Rechts, so dass sich Fragen von grundsätzlicher Bedeutung vorab bei deren Auslegung und Anwendung stellen können. Damit ist lediglich die subsidiäre Verfassungsbeschwerde zulässig.
1.4 Der Beschwerdeführer macht denn auch die Verletzung verfassungsmässiger Rechte geltend. Das Bundesgericht prüft die Verletzung von Grundrechten indes nicht von Amtes wegen, sondern nur, soweit eine solche gerügt und begründet wird (Art. 106 Abs. 2 BGG). Die Begründungspflicht lehnt sich bei der Verfassungsbeschwerde an die für die staatsrechtliche Beschwerde geltenden Anforderungen an (Art. 90 Abs. 1 lit. b aOG). Demnach prüft das Bundesgericht auch weiterhin nur klar und einlässlich erhobene und, soweit möglich, belegte Rügen. Hingegen tritt es auf rein appellatorische Kritik am angefochtenen Entscheid nicht ein. Macht der Beschwerdeführer eine Verletzung des Willkürverbotes geltend, muss er anhand des angefochtenen Entscheides im Einzelnen darlegen, inwiefern dieser im Ergebnis an einem qualifizierten Mangel leidet (BGE 133 III 393 E. 6 S. 397; 130 I 258 E. 1.3).
1.5 Inwiefern dem Beschwerdeführer das rechtliche Gehör und sein Anspruch auf unentgeltliche Prozessführung nach Art. 29 Abs. 3 BV verweigert worden sein sollen, wird nicht rechtsgenüglich begründet (Art. 117 in Verbindung mit Art. 106 Abs. 2 BGG). Es wird nicht dargetan, dass die Voraussetzungen für die Gewährung der unentgeltlichen Rechtspflege erfüllt gewesen seien und welche frist- und prozesskonform anerbotenen Beweismittel nicht abgenommen worden sein sollen. Darauf ist nicht einzutreten.
2. Der Beschwerdeführer trägt im Weiteren vor, das Kassationsgericht habe betreffend seinen Vorwurf, der Rechtsvertreter der Stockwerkeigentümer-Gemeinschaft habe Berufsregeln verletzt, das Willkürverbot von Art. 9 BV missachtet.
2.1 Im angefochtenen Entscheid (E. 2 b) wird - zusammengefasst - ausgeführt, für sein Vorbringen, Rechtsanwalt Dr. Z._ sei nicht ordnungsgemäss zum Rechtsvertreter der Beschwerdegegner bestellt worden, da es an der notwendigen Einstimmigkeit gefehlt habe, verweise der Beschwerdeführer auf das Protokoll der ausserordentlichen Stockwerkeigentümer-Versammlung vom 2. Juni 2004. An dieser Versammlung sei es zu drei Nein-Stimmen gekommen, eine davon diejenige des Beschwerdeführers. Aus diesen Ausführungen ergebe sich, dass der Beschwerdeführer seit dem 2. Juni 2004 gewusst habe, mit welchem Stimmenverhältnis Rechtsanwalt Dr. Z._ zum Rechtsvertreter der Beschwerdegegner bestimmt worden sei. Dieses Wissen habe er also schon am 15. April 2006 gehabt, als er die Nichtigkeitsbeschwerde erhoben habe, welche mit dem heute angefochtenen Beschluss des Kassationsgerichts vom 21. Dezember 2006 abgewiesen worden sei. Sollte der Beschwerdeführer weiter geltend machen, die Entscheide der Vorinstanzen seien mangels Bevollmächtigung von Rechtsanwalt Dr. Z._ als Rechtsvertreter der Beschwerdegegner aufzuheben, so hätte er dies mit staatsrechtlicher Beschwerde beim Bundesgericht tun können und müssen. Jedenfalls habe der Beschwerdeführer bereits während des Kassationsverfahrens die tatsächlichen Umstände gekannt, welche er heute anführe, um die ordnungsgemässe Vertretung der Beschwerdegegner durch Rechtsanwalt Dr. Z._ zu bestreiten. Damit sei die Frist von 90 Tagen seit der Entdeckung des behaupteten Revisionsgrundes (§ 295 Abs. 1 ZPO) offensichtlich nicht eingehalten. Was die behaupteten Verletzungen von Berufs- und Standesregeln durch den Rechtsvertreter angehe, zeige der Beschwerdeführer ebenfalls nicht auf, dass er von den betreffenden Handlungen erst in den 90 Tagen, die der Stellung des Revisionsbegehrens vorangegangen seien, erfahren habe. Das Vorbringen, er habe erst am 17. Dezember 2007 erfahren, dass die Führung eines Prozesses durch einen Rechtsanwalt unter Verletzung von Berufsregeln Nichtigkeitsgründe in der geführten Sache zur Folge haben könne, helfe dem Beschwerdeführer nicht. Revisionsgründe nach § 293 Abs. 1 ZPO/ZH seien nachträglich entdeckte Tatsachen und Beweismittel, nicht aber nachträglich erworbene Rechtskenntnisse.
2.2 Dagegen trägt der Beschwerdeführer im Wesentlichen vor, diese Erwägungen seien willkürlich. Die Entdeckung der Tatsache, dass Rechtsanwalt Dr. Z._ in seinen Tätigkeiten gleich mehrmals die Berufsregeln für Rechtsanwälte verletzt habe, seien für einen Laien wie den Beschwerdeführer nachträglich entdeckte Tatsachen und nicht nur nachträglich erworbene Rechtskenntnisse. Die Beweismittel für die nachträglich entdeckten Tatsachen der Verletzungen der Berufsregeln seien eingereicht worden.
Diese Einwendungen genügen den Begründungsanforderungen an eine Verfassungsbeschwerde nicht (E. 1.4 hiervor). Damit wird nicht dargetan, inwiefern die Vorinstanz § 293 Abs. 1 und § 295 Abs. 1 ZPO/ZH willkürlich angewendet haben soll (zur willkürlichen Rechtsanwendung: BGE 131 I 467 E. 3.1 S. 473 f. mit Hinweisen). Auf die Rügen ist demnach nicht einzutreten.
2.3 Ebenfalls nicht eingetreten werden kann auf die nicht näher begründeten Verletzungen weiterer verfassungsmässiger Rechte des Beschwerdeführers, welche sich aus seiner Strafanzeige vom 10. April 2008 ergeben sollen. Denn neue tatsächliche und neue rechtliche Vorbringen sind im Verfahren der subsidiären Verfassungsbeschwerde unzulässig (BGE 133 III 638 E. 2 S. 640).
3. Nach dem Ausgeführten kann auf die Verfassungsbeschwerde insgesamt nicht eingetreten werden. Der Beschwerdeführer hat für das bundesgerichtliche Verfahren das Gesuch um unentgeltliche Rechtspflege gestellt. Dem Begehren kann nicht entsprochen werden, da die Beschwerde von vornherein keine Aussicht auf Erfolg haben konnte (Art. 64 Abs. 1 BGG). Der Beschwerdeführer wird daher kostenpflichtig (Art. 66 Abs. 1 BGG). Eine Parteientschädigung an die Beschwerdegegner entfällt, da sie nicht zur Vernehmlassung eingeladen worden sind (vgl. Art. 68 Abs. 1 BGG).
Demnach erkennt das Bundesgericht:
1. Auf die subsidiäre Verfassungsbeschwerde wird nicht eingetreten.
2. Das Gesuch um unentgeltliche Rechtspflege wird abgewiesen.
3. Die Gerichtskosten von Fr. 800.-- werden dem Beschwerdeführer auferlegt.
4. Dieses Urteil wird den Parteien und dem Kassationsgericht des Kantons Zürich schriftlich mitgeteilt.
Lausanne, 18. Juli 2008
Im Namen der II. zivilrechtlichen Abteilung
des Schweizerischen Bundesgerichts
Das präsidierende Mitglied: Der Gerichtsschreiber:
Escher Schett